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


In This Topic
    FileSystemEventsSession Class
    In This Topic
    Class which holds information about the session which is responsible for raising all events that occur during the process.
    Object Model
    FileSystemEventsSession ClassProgressionInfo ClassByteProgressionEventArgs ClassFileSystemItem ClassFileSystemEvents ClassItemPair ClassFileSystemItem Class
    Syntax
    'Declaration
 

    Public Class FileSystemEventsSession 
    'Usage
 

    Dim instance As FileSystemEventsSession
    public class FileSystemEventsSession
    Inheritance Hierarchy

    System.Object
       Xceed.FileSystem.FileSystemEventsSession
          Xceed.Tar.TarEventsSession
          Xceed.Zip.ZipEventsSession

    Protected Constructors
     NameDescription
    Protected Internal ConstructorFileSystemEventsSession ConstructorInitializes a new instance of the FileSystemEventsSession class.  
    Top
    Protected Fields
     NameDescription
    Protected Fieldm_addingItemToProcessEventArgs  
    Protected Fieldm_allFilesBytesAn instance of the ProgressionInfo class representing the byte count information in regards to all the items to be processed for the current session.  
    Protected Fieldm_allItemsAn instance of the ProgressionInfo class representing the item count information for the current session.  
    Protected Fieldm_byteProgressionArgsAn instance of the ByteProgressionEventArgs class that provides byte progression information for the current session.  
    Protected Fieldm_currentFileBytesAn instance of the ProgressionInfo class representing the byte count information in regards to the current item being processed for the current session.  
    Protected Fieldm_currentItemThe current FileSystemItem object being processed for the current session.  
    Protected Fieldm_eventsAn instance of the FileSystemEvents class representing the original FileSystemEvents object from which we created the session.  
    Protected Fieldm_itemExceptionArgsAn instance of the ItemExceptionEventArgs class that provides information on the exception that was thrown during a process for the current session.  
    Protected Fieldm_itemPairListRepresents a sorted collection of the items to process for the current session. Some FileSystem implementations require sorting items before processing them in order to improve performance.  
    Protected Fieldm_itemPairQueueRepresents a first-in, first-out collection of the items to process for the current session.  
    Protected Fieldm_itemProgressionArgsAn instance of the ItemProgressionEventArgs class that provides item progression information for the current session.  
    Protected Fieldm_pathExceptionArgsAn instance of the PathExceptionEventArgs class that provides information on the exception that was thrown during processing of a path string.  
    Protected Fieldm_propertiesAppliedEventArgs  
    Protected Fieldm_scanningFolderArgsAn instance of the ScanningFolderEventArgs class that provides information on the folder being scanned or accessed for the current session.  
    Protected Fieldm_senderThe FileSystemItem object on which the process was called.  
    Protected Fieldm_targetItemThe current target FileSystemItem object of the process for the current session.  
    Protected Fieldm_userDataThis is set at construction, and updated after each event. It is assigned to each argument structure before each event.  
    Top
    Public Properties
     NameDescription
    Public PropertyAllFileBytesTODODOC  
    Public PropertyCurrentItemGets or sets the FileSystemItem object currently being processed.  
    Public PropertyEventsGets the original FileSystemEvents object used to create the session.  
    Public PropertyIsEmptyGets a boolean value indicating if the session's list of FileSystemItem objects to process contains no items.  
    Public PropertyMultiThreadManagerTODODOC  
    Public PropertyOptions  
    Public PropertyTargetItemGets or sets the eventual target FileSystemItem object for the process.  
    Public PropertyUserDataGets the opaque data that is sent back to the event handler when an event is raised.  
    Top
    Public Methods
     NameDescription
    Public MethodAssignComparerSorts the list of items to be processed using a specific comparer.  
    Public MethodCreateByteProgressionEventArgs  
    Public MethodGetNextItemPairOverloaded. Retrieves the next pair of FileSystemItem objects to be processed.  
    Public MethodOnBytesCompletedOverloaded. Forces the byte progression to 100% completion.  
    Public MethodOnBytesProcessedOverloaded. Raises the FileSystemEvents.ByteProgression event.  
    Public MethodOnCompletionRaises the last ItemProgression event when the process is completed.  
    Public MethodOnExceptionOverloaded. Raises the ItemException event whenever an error occurs during the processing of a FileSystemItem object.  
    Public MethodOnItemCompletedOverloaded. Raises the ItemCompletion event.  
    Public MethodOnNewItemToProcessPlaces the new item in the list of FileSystemItem objects to be processed.  
    Public MethodOnPathExceptionRaises the PathException event whenever an error occurs during the processing of a path string during construction of a FileSystem-derived object  
    Public MethodOnProcessingNewItemOverloaded. Called when a new item is about to be processed.  
    Public MethodOnPropertiesApplied  
    Public MethodOnScanningFolderRaises the ScanningFolder event.  
    Public MethodOnUndoBytesProcessedOverloaded. Removes the amount of bytes processed for an item if an error occurred during the processing of that item.  
    Top
    Protected Methods
     NameDescription
    Protected MethodGetItemSize  
    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

    FileSystemEventsSession Members
    Xceed.FileSystem Namespace

    Send Feedback