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


In This Topic
    SynchronizationEventsSession Class
    In This Topic
    This class is reserved for internal use and should not be called directly from your code. Class which holds information about the session which is responsible for raising all events that occur during the synchronization process.
    Object Model
    SynchronizationEventsSession ClassSynchronizationEvents Class
    Syntax
    'Declaration
 

    Public Class SynchronizationEventsSession 
    'Usage
 

    Dim instance As SynchronizationEventsSession
    public class SynchronizationEventsSession
    Inheritance Hierarchy

    System.Object
       Xceed.Synchronization.SynchronizationEventsSession

    Public Constructors
     NameDescription
    Public ConstructorSynchronizationEventsSession ConstructorThis method is reserved for internal use and should not be called directly from your code. Initializes a new instance of the SynchronizationEventsSession class.  
    Top
    Public Fields
     NameDescription
    Public FieldActionsThis field is reserved for internal use and should not be called directly from your code. An array of SynchronizationAction objects representing the actions to be taken for each item during synchronization.  
    Public FieldAllFilesBytesThis field is reserved for internal use and should not be called directly from your code. The total combined size, in bytes, of all files being processed.  
    Public FieldAllFilesItemsThis field is reserved for internal use and should not be called directly from your code. The total combined size, in bytes, of all files being processed.  
    Public FieldAnalysisArgsThis field is reserved for internal use and should not be called directly from your code. A SynchronizationAnalysisEventArgs object providing information when the analysis is being performed for the synchronization.  
    Public FieldCancelThis field is reserved for internal use and should not be called directly from your code. A boolean value.  
    Public FieldCompareFileDataArgsThis field is reserved for internal use and should not be called directly from your code. A SynchronizationCompareFileDataEventArgs object providing information when data is being compared during the synchronization.  
    Public FieldComponentAccessesMetaDataFileDataThis field is reserved for internal use and is not intended to be used directly from your code. A boolean value.  
    Public FieldConflictArgsThis field is reserved for internal use and should not be called directly from your code. A SynchronizationConflictEventArgs object providing information when a conflict occurs during the synchronization.  
    Public FieldConflictReasonsThis field is reserved for internal use and should not be called directly from your code. An arrray of SynchronizationConflictReason values representing the reason for the conflict, if any, for each item being synchronized.  
    Public FieldEmptyFolderThis field is reserved for internal use and should not be called directly from your code.  
    Public FieldFileThis field is reserved for internal use and should not be called directly from your code. An Xceed.FileSystem.AbstractFile object representing the master file that will be used to replace other files during the synchronization.  
    Public FieldFilesThis field is reserved for internal use and should not be called directly from your code. An array of Xceed.FileSystem.AbstractFile objects representing the files to be processed.  
    Public FieldFilesBytesThis field is reserved for internal use and should not be called directly from your code. The total combined size, in bytes, of all files being processed in a single file synchronization.  
    Public FieldFilesEqualToMasterThis field is reserved for internal use and should not be called directly from your code. An array of System.Boolean value indicating whether or not the files are equal to the master file.  
    Public FieldFilesItemsThis field is reserved for internal use and should not be called directly from your code. The total combined size, in bytes, of all files being processed in a single file synchronization.  
    Public FieldFilesToCompareThis field is reserved for internal use and should not be called directly from your code. An array of Xceed.FileSystem.AbstractFile objects representing the files to be compared to the master file.  
    Public FieldFileSystemEventsThis field is reserved for internal use and should not be called directly from your code.  
    Public FieldFileSystemEventsUserDataThis property is reserved for internal use and should not be called directly from your code.  
    Public FieldFolderThis field is reserved for internal use and should not be called directly from your code. An Xceed.FileSystem.AbstractFolder object representing the folder to synchronize.  
    Public FieldFolderAnalysisEventArgsThis field is reserved for internal use and should not be called directly from your code. A SynchronizationFolderAnalysisEventArgs object.  
    Public FieldFoldersThis field is reserved for internal use and should not be called directly from your code. An array of Xceed.FileSystem.AbstractFolder objects.  
    Public FieldFolderSynchronizationProgressionArgsThis field is reserved for internal use and should not be called directly from your code. A FolderSynchronizationProgressionEventArgs object providing information  
    Public FieldGetFileFromFolderArgsThis field is reserved for internal use and should not be called directly from your code. A GetSynchronizationFileFromFolderEventArgs object providing information when the synchronization file is being retrieved from a folder.  
    Public FieldHasMetaDataThis field is reserved for internal use and should not be called directly from your code. Whether metadata has been loaded for the synchronization.  
    Public FieldIsAFolderSynchronizationThis field is reserved for internal use and should not be called directly from your code. A boolean value indicating whether the synchronization is of a folder.  
    Public FieldItemsThis field is reserved for internal use and should not be called directly from your code. An array of Xceed.FileSystem.FileSystemItem objects representing the items to be processed.  
    Public FieldLastIdenticalFilesThis field is reserved for internal use and should not be called directly from your code.  
    Public FieldLastSynchronizationChecksumsThis field is reserved for internal use and should not be called directly from your code.  
    Public FieldLastSynchronizationDateThis field is reserved for internal use and should not be called directly from your code. A System.DateTime object representing the date and time when the last synchronization was performed.  
    Public FieldMasterIndexThis field is reserved for internal use and should not be called directly from your code. A value representing the item in a list of items to be used as the master during the synchronization process.  
    Public FieldMetaDataFileThis field is reserved for internal use and is not intended to be used directly from your code. An Xceed.FileSystem.AbstractFile object representing a meta data file.  
    Public FieldMetaDataItemThis field is reserved for internal use and is not intended to be used directly from your code. A Xceed.FileSystem.FileSystemItem object representing a meta data Xceed.FileSystem item.  
    Public FieldMetaDataLoadArgsThis field is reserved for internal use and should not be called directly from your code. A SynchronizationMetaDataLoadEventArgs object providing information on the meta data as it is loaded used during the synchronization.  
    Public FieldMetaDataReaderThis field is reserved for internal use and should not be called directly from your code. An System.Xml.XmlReader object representing the meta data reader.  
    Public FieldMetaDataSaveArgsThis field is reserved for internal use and should not be called directly from your code. A SynchronizationMetaDataEventArgs object providing information on the meta data as it is saved used during the synchronization.  
    Public FieldMetaDataWriterThis field is reserved for internal use and should not be called directly from your code. An System.Xml.XmlWriter object representing the meta data writer.  
    Public FieldNameThis field is reserved for internal use and should not be called directly from your code. A string representing the name of the SynchronizationEventsSession.  
    Public FieldOptionsThis field is reserved for internal use and should not be called directly from your code. A SynchronizationOptions object representing the options used during the synchronization.  
    Public FieldOriginalMasterIndexThis field is reserved for internal use and should not be called directly from your code. A value representing the item in a list of items to be used as the master during the synchronization process.  
    Public FieldProcessedContentThis field is reserved for internal use and should not be called directly from your code. An array of System.Collections.Hashtable objects representing the processed content.  
    Public FieldProgressionArgsThis field is reserved for internal use and should not be called directly from your code. A SynchronizationProgressionEventArgs object providing information  
    Public FieldSynchronizationResultThis field is reserved for internal use and should not be called directly from your code. A value representing one or more results of the synchronization.  
    Public FieldUserDataThis field is reserved for internal use and should not be called directly from your code. This is set at construction, and updated after each event. It is assigned to each argument structure before each event.  
    Top
    Protected Fields
     NameDescription
    Protected FieldEventsInternalThis field is reserved for internal use and should not be called directly from your code. A SynchronizationEvents object representing the synchronization events of the session.  
    Protected FieldSenderInternalThis field is reserved for internal use and should not be called directly from your code. The Xceed.FileSystem.FileSystemItem object on which the process was called.  
    Top
    Public Properties
     NameDescription
    Public PropertySynchronizationEventsThis property reserved for internal use and should not be called directly from your code. Gets the synchronization events of the session.  
    Top
    Public Methods
     NameDescription
    Public MethodAddFilesBytesToProcessThis method is reserved for internal use and is not intended to be used directly from your code.  
    Public MethodAddItemsToProcessThis method is reserved for internal use and is not intended to be used directly from your code.  
    Public MethodOnAnalysisThis method is reserved for internal use and should not be called directly from your code. Calls SynchronizationEvents.OnAnalysis if the SynchronizationEvents.WantsAnalysis property is set to true.  
    Public MethodOnCompareFileDataThis method is reserved for internal use and should not be called directly from your code. Calls SynchronizationEvents.OnCompareFileData if the SynchronizationEvents.WantsCompareFileData property is set to true.  
    Public MethodOnCompletedThis method is reserved for internal use and is not intended to be used directly from your code. Forces the progression to 100% completion.  
    Public MethodOnConflictThis method is reserved for internal use and is not intended to be used directly from your code. Calls SynchronizationEvents.OnConflict if the SynchronizationEvents.WantsConflict is set to true.  
    Public MethodOnExceptionThis method is reserved for internal use and is not intended to be used directly from your code.  
    Public MethodOnFolderOperationAnalysisThis method is reserved for internal use and should not be called directly from your code. Calls SynchronizationEvents.OnFolderOperationAnalysis if the SynchronizationEvents.WantsFolderOperationAnalysis property is set to true.  
    Public MethodOnFolderSynchronizationProgressionThis method is reserved for internal use and should not be called directly from your code. Calls SynchronizationEvents.OnFolderSynchronizationProgression if the SynchronizationEvents.WantsFolderSynchronizationProgression property is set to true.  
    Public MethodOnGettingSynchronizationFileFromFolderThis method is reserved for internal use and should not be called directly from your code. Calls SynchronizationEvents.OnGettingSynchronizationFileFromFolder if the SynchronizationEvents.WantsGetSynchronizationFileFromFolder property is set to true.  
    Public MethodOnLoadingMetaDataThis method is reserved for internal use and should not be called directly from your code. Calls SynchronizationEvents.OnLoadingMetaData if the SynchronizationEvents.WantsLoadingMetaData property is set to true.  
    Public MethodOnMetaDataLoadedThis method is reserved for internal use and should not be called directly from your code. Calls SynchronizationEvents.OnMetaDataLoaded if the SynchronizationEvents.WantsMetaDataLoaded property is set to true.  
    Public MethodOnMetaDataSavedThis method is reserved for internal use and should not be called directly from your code. Calls SynchronizationEvents.OnMetaDataSaved if the SynchronizationEvents.WantsMetaDataSaved property is set to true.  
    Public MethodOnProgressionThis method is reserved for internal use and is not intended to be used directly from your code. Raises the SynchronizationEvents.SynchronizationProgression event.  
    Public MethodOnSavingMetaDataThis method is reserved for internal use and should not be called directly from your code. Calls SynchronizationEvents.OnSavingMetaData if the SynchronizationEvents.WantsSavingMetaData property is set to true.  
    Public MethodOnUndoBytesProcessedThis method is reserved for internal use and is not intended to be used directly from your code. Removes the amount of bytes processed for an item if an error occurred during the processing of that item.  
    Public MethodSetAnalysisArgsOverloaded. This method is reserved for internal use and should not be called directly from your code.  
    Public MethodSetCompareFileDataArgsOverloaded. This method is reserved for internal use and should not be called directly from your code.  
    Public MethodSetConflictArgsOverloaded. This method is reserved for internal use and should not be called directly from your code.  
    Public MethodSetFolderOperationAnalysisArgsOverloaded. This method is reserved for internal use and should not be called directly from your code.  
    Public MethodSetFolderProgressionArgsThis method is reserved for internal use and should not be called directly from your code.  
    Public MethodSetGetFileFromFolderArgsOverloaded. This method is reserved for internal use and should not be called directly from your code.  
    Public MethodSetMetaDataLoadArgsThis method is reserved for internal use and should not be called directly from your code.  
    Public MethodSetMetaDataSaveArgsThis method is reserved for internal use and should not be called directly from your code.  
    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

    SynchronizationEventsSession Members
    Xceed.Synchronization Namespace

    Send Feedback