Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.Synchronization Assembly / Xceed.Synchronization Namespace / SynchronizationEvents Class


In This Topic
    SynchronizationEvents Class
    In This Topic
    Class that dispatches events associated with synchronization operations.
    Object Model
    SynchronizationEvents ClassSynchronizationEventsSession ClassSynchronizationEvents Class
    Syntax
    'Declaration
 

    Public Class SynchronizationEvents 
    'Usage
 

    Dim instance As SynchronizationEvents
    public class SynchronizationEvents
    Inheritance Hierarchy

    System.Object
       Xceed.Synchronization.SynchronizationEvents

    Public Constructors
     NameDescription
    Public ConstructorSynchronizationEvents ConstructorInitializes a new instance of the SynchronizationEvents class.  
    Top
    Public Properties
     NameDescription
    Public Propertystatic (Shared in Visual Basic)EmptyThis property is reserved for internal use and is not intended to be used directly from your code.  
    Top
    Protected Properties
     NameDescription
    Protected Internal PropertyWantsAnalysisGets a boolean value indicating whether the SynchronizationEvents object has subscribed to the Analysis event.  
    Protected Internal PropertyWantsCompareFileDataGets a boolean value indicating whether the SynchronizationEvents object has subscribed to the CompareFileData event.  
    Protected Internal PropertyWantsConflictGets a boolean value indicating whether the SynchronizationEvents object has subscribed to the Conflict event.  
    Protected Internal PropertyWantsFolderOperationAnalysisGets a boolean value indicating whether the SynchronizationEvents object has subscribed to the FolderOperationAnalysis event.  
    Protected Internal PropertyWantsFolderSynchronizationProgressionGets a boolean value indicating whether the SynchronizationEvents object has subscribed to the FolderSynchronizationProgression event.  
    Protected Internal PropertyWantsGetSynchronizationFileFromFolderGets a boolean value indicating whether the SynchronizationEvents object has subscribed to the GettingSynchronizationFileFromFolder event.  
    Protected Internal PropertyWantsLoadingMetaDataGets a boolean value indicating whether the SynchronizationEvents object has subscribed to the LoadingMetaData event.  
    Protected Internal PropertyWantsMetaDataLoadedGets a boolean value indicating whether the SynchronizationEvents object has subscribed to the MetaDataLoaded event.  
    Protected Internal PropertyWantsMetaDataSavedGets a boolean value indicating whether the SynchronizationEvents object has subscribed to the MetaDataSaved event.  
    Protected Internal PropertyWantsSavingMetaDataGets a boolean value indicating whether the SynchronizationEvents object has subscribed to the SavingMetaData event.  
    Protected Internal PropertyWantsSynchronizationProgressionGets a boolean value indicating whether the SynchronizationEvents object has subscribed to the SynchronizationProgression event.  
    Top
    Public Methods
     NameDescription
    Public MethodCreateSessionCreates and initializes a new SynchronizationEventsSession object from the current SynchronizationEvents instance.  
    Top
    Protected Methods
     NameDescription
    Protected Internal MethodOnAnalysisRaises the Analysis event.  
    Protected Internal MethodOnCompareFileDataRaises the CompareFileData event.  
    Protected Internal MethodOnConflictRaises the Conflict event.  
    Protected Internal MethodOnFolderOperationAnalysisRaises the FolderOperationAnalysis event.  
    Protected Internal MethodOnFolderSynchronizationProgressionRaises the FolderSynchronizationProgression event.  
    Protected Internal MethodOnGettingSynchronizationFileFromFolderRaises the GettingSynchronizationFileFromFolder event.  
    Protected Internal MethodOnLoadingMetaDataRaises the LoadingMetaData event.  
    Protected Internal MethodOnMetaDataLoadedRaises the MetaDataLoaded event.  
    Protected Internal MethodOnMetaDataSavedRaises the MetaDataSaved event.  
    Protected Internal MethodOnSavingMetaDataRaises the SavingMetaData event.  
    Protected Internal MethodOnSynchronizationProgressionRaises the SynchronizationProgression event.  
    Protected MethodValidateParamsVerifies the validity of the parameters sent to the event handlers.  
    Top
    Public Events
     NameDescription
    Public EventAnalysisRaised when the analysis is being performed.  
    Public EventCompareFileDataRaised when the file data is compared.  
    Public EventConflictRaised when there is a conflict.  
    Public EventFolderOperationAnalysisRaised when the analysis is being performed.  
    Public EventFolderSynchronizationProgressionRaised every time an AbstractFile object, from a folder being synchronized, is about to be synchronized, providing, if enabled, progression information to the event handler.  
    Public EventGettingSynchronizationFileFromFolderRaised when the synchronization file is being gotten from the folder.  
    Public EventLoadingMetaDataRaised when the meta data is being loaded.  
    Public EventMetaDataLoadedRaised when the meta data has been loaded.  
    Public EventMetaDataSavedRaised when the meta data has been saved.  
    Public EventSavingMetaDataRaised when the meta data is being saved.  
    Public EventSynchronizationProgressionRaised periodically during the synchronization of Xceed.FileSystem.AbstractFile objects providing progression information to the event handler.  
    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

    Reference

    SynchronizationEvents Members
    Xceed.Synchronization Namespace

    Send Feedback