FileSyncProvider.PreviewMode Property

  • Article

Gets or sets a value that indicates whether the provider is in preview mode.

Namespace: Microsoft.Synchronization.Files
Assembly: Microsoft.Synchronization.Files (in microsoft.synchronization.files.dll)

Syntax

'Declaration
Public Property PreviewMode As Boolean
'Usage
Dim instance As FileSyncProvider
Dim value As Boolean

value = instance.PreviewMode

instance.PreviewMode = value

public bool PreviewMode { get; set; }

public:
property bool PreviewMode {
    bool get ();
    void set (bool value);
}

/** @property */
public boolean get_PreviewMode ()

/** @property */
public void set_PreviewMode (boolean value)

public function get PreviewMode () : boolean

public function set PreviewMode (value : boolean)

Property Value

true if the provider is in preview mode; otherwise, false. The default is false.

Exceptions

Exception type Condition

ObjectDisposedException

The object has been disposed or was not property initialized.

Remarks

If the provider is in preview mode, all synchronization actions will be performed as if for an actual synchronization session; however, no changes will be applied. This means that progress notifications will still be sent out for changes that would have been applied and change detection will be performed. Because of this, using preview mode could potentially be an expensive operation.

For information about how to use preview mode to show incremental synchronization progress to the user, see Reporting File Synchronization Progress.

See Also

Reference

FileSyncProvider Class
FileSyncProvider Members
Microsoft.Synchronization.Files Namespace