Xceed .NET Libraries Documentation
Xceed.Synchronization Assembly / Xceed.Synchronization Namespace / SynchronizationOptions Class


In This Topic
    SynchronizationOptions Class
    In This Topic
    Represents the options used during the synchronization.
    Object Model
    SynchronizationOptions ClassSynchronizationOptions Class
    Syntax
    'Declaration
     
    
    Public Class SynchronizationOptions 
       Implements System.ICloneable 
    'Usage
     
    
    Dim instance As SynchronizationOptions
    public class SynchronizationOptions : System.ICloneable  
    Inheritance Hierarchy

    System.Object
       Xceed.Synchronization.SynchronizationOptions

    Public Constructors
     NameDescription
    Public ConstructorOverloaded. Represents the options used during the synchronization.  
    Top
    Public Fields
     NameDescription
    Public FieldA boolean value indicating whether new files can be created during the synchronization process.  
    Public FieldA boolean value indicating whether deletions will be allowed during the synchronization.  
    Public FieldA boolean value indicating whether conflicts should be resolved automatically.  
    Public FieldAn integer value specifying the amount of byte progression required to trigger the SynchronizationProgression event.  
    Public FieldA boolean value indicating whether file data will be compared to detect conflicts between files. If set to false, only the date and time of files will be used to detect conflicts during the synchronization.  
    Public FieldA boolean value indicating whether the Xceed.FileSystem.FileSystemItem.Refresh method should be called before using an item's dates and attribute in the synchronization.  
    Public FieldA boolean value indicating whether the synchronization will be performed in preview-mode only, that is, without making any changes to files.  
    Public Field

    A boolean value indicating whether, during a folder synchronization, a folder should be processed even if this is deemed logically unnecessary by the synchronization algorithm.

    If set to true, unnecessary folders are scanned for files to synchronize as normal. If set to false, the files in unnecessary folders are ignored completely by the algorithm.

     
    Public FieldA boolean value indicating whether to recurse into subfolders: true if files and folders contained in the subfolders should be synchronized; false if only files that are immediate children of a folder should be synchronized.  
    Public FieldA boolean value indicating whether meta data should be used during the synchronization.  
    Top
    Public Properties
     NameDescription
    Public Propertystatic (Shared in Visual Basic)Gets the default synchronization options.  
    Top
    Public Methods
     NameDescription
    Public MethodCreates a copy of this SynchronizationOptions object.  
    Public MethodCopies the values of the current SynchronizationOptions object to the supplied SynchronizationOptions object.  
    Public MethodResets the values of the current SynchronizationOptions object to the values found in the Default object.  
    Top
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also