Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.FileSystem Assembly / Xceed.FileSystem Namespace / FileSystemEvents Class
Members


In This Topic
    FileSystemEvents Class
    In This Topic
    Class that dispatches events raised from methods called on FileSystemItem objects or objects that derive from the FileSystemItem class.
    Syntax
    'Declaration
 
Public Class FileSystemEvents 
    'Usage
 
Dim instance As FileSystemEvents
    public class FileSystemEvents
    Remarks

    This class serves as a central point of access to associate event handlers with method calls, for methods that need to raise events.

    Inheritance Hierarchy

    System.Object
       Xceed.FileSystem.FileSystemEvents
          Xceed.Tar.TarEvents
          Xceed.Zip.ZipEvents

    Public Constructors
     NameDescription
    Public ConstructorFileSystemEvents Constructor  
    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 PropertyWantsAddingItemToProcess  
    Protected Internal PropertyWantsByteProgressionGets a boolean value indicating if the FileSystemEvents object has subscribed to the ByteProgression event.  
    Protected Internal PropertyWantsItemCompletionGets a System.Boolean value indicating if the FileSystemEvents object has subscribed to the ItemCompletion event.  
    Protected Internal PropertyWantsItemExceptionGets a boolean value indicating if the FileSystemEvents object has subscribed to the ItemException event.  
    Protected Internal PropertyWantsItemProgressionGets a boolean value indicating if the FileSystemEvents object has subscribed to the ItemProgression event.  
    Protected Internal PropertyWantsPathExceptionGets a boolean value indicating if the FileSystemEvents object has subscribed to the PathException event.  
    Protected Internal PropertyWantsPropertiesAppliedToItem  
    Protected Internal PropertyWantsScanningFolderGets a boolean value indicating if the FileSystemEvents object has subscribed to the ScanningFolder event.  
    Top
    Public Methods
     NameDescription
    Public MethodBeginSubOperationCalled when a sub-operation is begun within a process.  
    Public MethodCreateSessionOverloaded. Initializes a new session from a FileSystemEvents object.  
    Public MethodEndSubOperationCalled when a sub-operation is ended within a process.  
    Top
    Protected Methods
     NameDescription
    Protected Internal MethodOnAddingItemToProcess  
    Protected Internal MethodOnByteProgressionRaises the ByteProgression event.  
    Protected Internal MethodOnItemCompletionRaises the ItemCompletion event.  
    Protected Internal MethodOnItemExceptionRaises the ItemException event.  
    Protected Internal MethodOnItemProgressionRaises the ItemProgression event.  
    Protected Internal MethodOnPathExceptionRaises the PathException event.  
    Protected Internal MethodOnPropertiesAppliedToItem  
    Protected Internal MethodOnScanningFolderRaises the ScanningFolder event.  
    Protected MethodValidateParamsVerifies the validity of the parameters sent to the event handlers.  
    Top
    Public Events
     NameDescription
    Public EventAddingItemToProcessRaised every time a FileSystemItem object is about to be added to the list of items to be processed, providing information to the event handler and optional actions to be taken.  
    Public EventByteProgressionRaised for every 64k of bytes processed when a FileSystemItem object is being processed.  
    Public EventItemCompletionRaised every time a FileSystemItem object has been processed, providing progression information to the event handler and the ability to perform custom post-processing on the target item.  
    Public EventItemExceptionRaised when an exception is caught during the processing of a FileSystemItem object, allowing the handler to decide the action to take.  
    Public EventItemProgressionRaised every time a FileSystemItem object is about to be processed, providing progression information to the event handler.  
    Public EventPathExceptionRaised when an exception is caught during the processing of a path string, allowing the handler to correct the path and retry the operation.  
    Public EventPropertiesAppliedToItem  
    Public EventScanningFolderRaised when an AbstractFolder object is accessed or is scanned for matching items while building a list of items to process.  
    Top
    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

    Reference

    FileSystemEvents Members
    Xceed.FileSystem Namespace

    Send Feedback