Xceed Logo
Shop
Xceed .NET Libraries Documentation
Xceed.Zip Assembly / Xceed.Zip Namespace / ZipEventsSession Class
Fields Properties Methods


In This Topic
    ZipEventsSession Class Members
    In This Topic

    The following tables list the members exposed by ZipEventsSession.

    Protected Constructors
     NameDescription
    Protected Internal ConstructorZipEventsSession ConstructorInitializes a new instance of the ZipEventsSession class.  
    Top
    Protected Fields
     NameDescription
    Protected Fieldm_addingItemToProcessEventArgs (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    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. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_allItemsAn instance of the ProgressionInfo class representing the item count information for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_buildingZipByteProgressionArgsAn instance of the Xceed.FileSystem.ByteProgressionEventArgs class that provides byte progression information for the current session.  
    Protected Fieldm_buildingZipItemProgressionArgsAn instance of the Xceed.FileSystem.ItemProgressionEventArgs class that provides item progression information for the current session.  
    Protected Fieldm_byteProgressionArgsAn instance of the Xceed.FileSystem.ByteProgressionEventArgs class that provides byte progression information for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_copyingZipByteProgressionArgsAn instance of the Xceed.FileSystem.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. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_currentItemThe current Xceed.FileSystem.FileSystemItem object being processed for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_eventsAn instance of the Xceed.FileSystem.FileSystemEvents class representing the original Xceed.FileSystem.FileSystemEvents object from which we created the session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_gatheringZipContentByteProgressionArgsAn instance of the Xceed.FileSystem.ByteProgressionEventArgs class that provides byte progression information for the current session.  
    Protected Fieldm_itemExceptionArgsAn instance of the Xceed.FileSystem.ItemExceptionEventArgs class that provides information on the exception that was thrown during a process for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    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. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_itemPairQueueRepresents a first-in, first-out collection of the items to process for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_itemProgressionArgsAn instance of the Xceed.FileSystem.ItemProgressionEventArgs class that provides item progression information for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_pathExceptionArgs (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_propertiesAppliedEventArgs (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_readingZipItemProgressionArgsAn instance of the Xceed.FileSystem.ItemProgressionEventArgs class that provides item progression information for the current session.  
    Protected Fieldm_scanningFolderArgsAn instance of the Xceed.FileSystem.ScanningFolderEventArgs class that provides information on the folder being scanned or accessed for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_senderThe Xceed.FileSystem.FileSystemItem object on which the process was called. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_targetItemThe current target Xceed.FileSystem.FileSystemItem object of the process for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_userDataThis is set at construction, and updated after each event. It is assigned to each argument structure before each event. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Protected Fieldm_zipAllFilesBytesAn 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_zipAllItemsAn instance of the ProgressionInfo class representing the item count information for the current session.  
    Protected Fieldm_zipCurrentFileBytesAn instance of the ProgressionInfo class representing the byte count information in regards to the current item being processed for the current session.  
    Protected Fieldm_zipEventsAn instance of the ZipEvents class representing the original ZipEvents object from which we created the session.  
    Top
    Public Properties
     NameDescription
    Public PropertyAllFileBytes (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public PropertyCurrentItemGets or sets the Xceed.FileSystem.FileSystemItem object currently being processed. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public PropertyEventsGets the original ZipEvents object that was used to create the session.  
    Public PropertyIsEmptyGets a boolean value indicating if the session's list of Xceed.FileSystem.FileSystemItem objects to process contains no items. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public PropertyMultiThreadManager (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public PropertyOptions (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public PropertyTargetItemGets or sets the eventual target Xceed.FileSystem.FileSystemItem object for the process. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public PropertyUserDataGets the opaque data that is sent back to the event handler when an event is raised. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public PropertyZipAllFileBytesGets the ProgressionInfo object representing the byte count information in regards to all the items to be processed for the current sesstion.  
    Public PropertyZipAllItemsGets the ProgressionInfo object representing the item count information for the current session.  
    Public PropertyZipCurrentFileBytesGets the ProgressionInfo object representing the byte count information in regards to the current item being processed for the current session.  
    Top
    Public Methods
     NameDescription
    Public MethodAssignComparerSorts the list of items to be processed using a specific comparer. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public MethodCreateByteProgressionEventArgs (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public MethodGetNextItemPairOverloaded.  (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public MethodInitializeCurrentTotalBytesInitializes the total amount of bytes for the current zip item to be processed.  
    Public MethodInitializeTotalBytesInitializes the total amount of bytes for all zip items to be processed.  
    Public MethodInitializeTotalItemsInitializes the total amount of zip items to be processed.  
    Public MethodOnBuildingZipByteCompletionThe last BuildingZipByteProgression event raised once processing of a zip item is completed.  
    Public MethodOnBuildingZipByteProgressionRaises the BuildingZipByteProgression event.  
    Public MethodOnBuildingZipItemCompletionThe last BuildingZipItemProgression event raised once processing is completed.  
    Public MethodOnBuildingZipItemProgressionRaises the BuildingZipItemProgression event.  
    Public MethodOnBytesCompletedOverloaded.  (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public MethodOnBytesProcessedOverloaded.  (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public MethodOnCompletionRaises the last ItemProgression event when the process is completed. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public MethodOnCopyingZipByteCompletionOBSOLETE : You can override OnGatheringZipContentByteCompletion to get status on the step preceding the creation of the zip file. The last CopyingZipByteProgression event raised once processing for a zip file is completed.  
    Public MethodOnDiskRequiredRaises the DiskRequired event.  
    Public MethodOnExceptionOverloaded.  (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public MethodOnGatheringZipContentByteCompletionThe last GatheringZipContentByteProgression event raised once processing is completed.  
    Public MethodOnGatheringZipContentByteProgressionRaises the GatheringZipContentByteProgression event.  
    Public MethodOnItemCompletedOverloaded.  (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public MethodOnNewItemToProcessPlaces the new item in the list of Xceed.FileSystem.FileSystemItem objects to be processed. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public MethodOnPathExceptionRaises the PathException event whenever an error occurs during the processing of a path string during construction of a FileSystem-derived object (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public MethodOnProcessingNewItemOverloaded.  (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public MethodOnPropertiesApplied (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public MethodOnReadingZipItemCompletionThe last ReadingZipItemProgression event raised once processing is completed.  
    Public MethodOnReadingZipItemProgression  
    Public MethodOnScanningFolderRaises the Xceed.FileSystem.FileSystemEvents.ScanningFolder event. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Public MethodOnUndoBytesProcessedOverloaded.  (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Top
    Protected Methods
     NameDescription
    Protected MethodGetItemSize (Inherited from Xceed.FileSystem.FileSystemEventsSession)
    Top
    See Also

    Reference

    ZipEventsSession Class
    Xceed.Zip Namespace

    Send Feedback