Xceed .NET Libraries Documentation
Xceed.Synchronization Assembly / Xceed.Synchronization Namespace / SynchronizationEvents Class / FolderSynchronizationProgression Event


In This Topic
    FolderSynchronizationProgression Event
    In This Topic
    Raised every time an AbstractFile object, from a folder being synchronized, is about to be synchronized, providing, if enabled, progression information to the event handler.
    Syntax
    'Declaration
     
    Public Event FolderSynchronizationProgression As FolderSynchronizationProgressionEventHandler
    'Usage
     
    Dim instance As SynchronizationEvents
    Dim handler As FolderSynchronizationProgressionEventHandler
     
    AddHandler instance.FolderSynchronizationProgression, handler
    public event FolderSynchronizationProgressionEventHandler FolderSynchronizationProgression
    Event Data

    The event handler receives an argument of type FolderSynchronizationProgressionEventArgs containing data related to this event. The following FolderSynchronizationProgressionEventArgs properties provide information specific to this event.

    PropertyDescription
    Gets or sets a boolean value indicating whether the entire synchronization should be aborted.  
    Gets or sets a boolean value indicating whether the impending synchronization of the current file should be cancelled.  
    Gets an Xceed.FileSystem.AbstractFile object representing the file that is about to be synchronized as part of an ongoing folder synchronization.  
    An array of Xceed.FileSystem.Filter objects. These filters will be applied to each item in the Items array before synchronization begins.  
    An array of integers containing indexes of the Items array that specify items who should be considered irrelevant when trying to designate a master item.  
    Gets a boolean value indicating whether this is the first synchronization with the current items. (Inherited from Xceed.Synchronization.SynchronizationEventArgs)
    Gets a boolean value indicating whether the current synchronization is part of a larger synchronization job where folders are being synchronized. (Inherited from Xceed.Synchronization.SynchronizationEventArgs)
    An array of Xceed.FileSystem.FileSystemItem containing the items to be synchronized.  
    Gets or sets the index of the item to be used as the master during the synchronization process.  
    A Xceed.FileSystem.FileSystemItem object representing the location where meta data, if enabled, can be accessed.  
    Gets or set the SynchronizationOptions that will be used for the current synchronization job. (Inherited from Xceed.Synchronization.SynchronizationEventArgs)
    Gets or sets the opaque data that will be sent back to the event handler whenever an event is raised. (Inherited from Xceed.Synchronization.SynchronizationEventArgs)
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also