ZipEventsSession Class

In This Topic

Class which derives from the Xceed.FileSystem.FileSystemEventsSession class and holds information about the session which is responsible for raising all events that occur during the process.

Object Model

Syntax

Visual Basic
C#

'Declaration
 
Public Class ZipEventsSession 
   Inherits Xceed.FileSystem.FileSystemEventsSession

'Usage
 
Dim instance As ZipEventsSession

public class ZipEventsSession : Xceed.FileSystem.FileSystemEventsSession

Inheritance Hierarchy

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

Protected Constructors

	Name	Description
	ZipEventsSession Constructor	Initializes a new instance of the ZipEventsSession class.

Top

Protected Fields

	Name	Description
	m_addingItemToProcessEventArgs	(Inherited from Xceed.FileSystem.FileSystemEventsSession)
	m_allFilesBytes	An 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)
	m_allItems	An instance of the ProgressionInfo class representing the item count information for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	m_buildingZipByteProgressionArgs	An instance of the Xceed.FileSystem.ByteProgressionEventArgs class that provides byte progression information for the current session.
	m_buildingZipItemProgressionArgs	An instance of the Xceed.FileSystem.ItemProgressionEventArgs class that provides item progression information for the current session.
	m_byteProgressionArgs	An instance of the Xceed.FileSystem.ByteProgressionEventArgs class that provides byte progression information for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	m_copyingZipByteProgressionArgs	An instance of the Xceed.FileSystem.ByteProgressionEventArgs class that provides byte progression information for the current session.
	m_currentFileBytes	An 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)
	m_currentItem	The current Xceed.FileSystem.FileSystemItem object being processed for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	m_events	An 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)
	m_gatheringZipContentByteProgressionArgs	An instance of the Xceed.FileSystem.ByteProgressionEventArgs class that provides byte progression information for the current session.
	m_itemExceptionArgs	An 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)
	m_itemPairList	Represents 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)
	m_itemPairQueue	Represents a first-in, first-out collection of the items to process for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	m_itemProgressionArgs	An instance of the Xceed.FileSystem.ItemProgressionEventArgs class that provides item progression information for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	m_pathExceptionArgs	An instance of the Xceed.FileSystem.PathExceptionEventArgs class that provides information on the exception that was thrown during processing of a path string. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	m_propertiesAppliedEventArgs	(Inherited from Xceed.FileSystem.FileSystemEventsSession)
	m_readingZipItemProgressionArgs	An instance of the Xceed.FileSystem.ItemProgressionEventArgs class that provides item progression information for the current session.
	m_scanningFolderArgs	An 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)
	m_sender	The Xceed.FileSystem.FileSystemItem object on which the process was called. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	m_targetItem	The current target Xceed.FileSystem.FileSystemItem object of the process for the current session. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	m_userData	This is set at construction, and updated after each event. It is assigned to each argument structure before each event. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	m_zipAllFilesBytes	An instance of the ProgressionInfo class representing the byte count information in regards to all the items to be processed for the current session.
	m_zipAllItems	An instance of the ProgressionInfo class representing the item count information for the current session.
	m_zipCurrentFileBytes	An instance of the ProgressionInfo class representing the byte count information in regards to the current item being processed for the current session.
	m_zipEvents	An instance of the ZipEvents class representing the original ZipEvents object from which we created the session.

Top

Public Properties

	Name	Description
	AllFileBytes	TODODOC (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	CurrentItem	Gets or sets the Xceed.FileSystem.FileSystemItem object currently being processed. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	Events	Gets the original ZipEvents object that was used to create the session.
	IsEmpty	Gets a boolean value indicating if the session's list of Xceed.FileSystem.FileSystemItem objects to process contains no items. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	MultiThreadManager	TODODOC (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	Options	(Inherited from Xceed.FileSystem.FileSystemEventsSession)
	TargetItem	Gets or sets the eventual target Xceed.FileSystem.FileSystemItem object for the process. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	UserData	Gets the opaque data that is sent back to the event handler when an event is raised. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	ZipAllFileBytes	Gets the ProgressionInfo object representing the byte count information in regards to all the items to be processed for the current sesstion.
	ZipAllItems	Gets the ProgressionInfo object representing the item count information for the current session.
	ZipCurrentFileBytes	Gets the ProgressionInfo object representing the byte count information in regards to the current item being processed for the current session.

Top

Public Methods

	Name	Description
	AssignComparer	Sorts the list of items to be processed using a specific comparer. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	CreateByteProgressionEventArgs	(Inherited from Xceed.FileSystem.FileSystemEventsSession)
	GetNextItemPair	Overloaded. Retrieves the next pair of Xceed.FileSystem.FileSystemItem objects to be processed. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	InitializeCurrentTotalBytes	Initializes the total amount of bytes for the current zip item to be processed.
	InitializeTotalBytes	Initializes the total amount of bytes for all zip items to be processed.
	InitializeTotalItems	Initializes the total amount of zip items to be processed.
	OnBuildingZipByteCompletion	The last BuildingZipByteProgression event raised once processing of a zip item is completed.
	OnBuildingZipByteProgression	Raises the BuildingZipByteProgression event.
	OnBuildingZipItemCompletion	The last BuildingZipItemProgression event raised once processing is completed.
	OnBuildingZipItemProgression	Raises the BuildingZipItemProgression event.
	OnBytesCompleted	Overloaded. Forces the byte progression to 100% completion. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	OnBytesProcessed	Overloaded. Raises the FileSystemEvents.ByteProgression event. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	OnCompletion	Raises the last ItemProgression event when the process is completed. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	OnCopyingZipByteCompletion	OBSOLETE : 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.
	OnCopyingZipByteProgression	OBSOLETE : This method should no longer be called. You can override OnGatheringZipContentByteProgression to get status on the step preceding the creation of the zip file. Raises the CopyingZipByteProgression event.
	OnDiskRequired	Raises the DiskRequired event.
	OnException	Overloaded. Raises the ItemException event whenever an error occurs during the processing of a Xceed.FileSystem.FileSystemItem object. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	OnGatheringZipContentByteCompletion	The last GatheringZipContentByteProgression event raised once processing is completed.
	OnGatheringZipContentByteProgression	Raises the GatheringZipContentByteProgression event.
	OnItemCompleted	Overloaded. Raises the ItemCompletion event. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	OnNewItemToProcess	Places the new item in the list of Xceed.FileSystem.FileSystemItem objects to be processed. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	OnPathException	Raises 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)
	OnProcessingNewItem	Overloaded. Called when a new item is about to be processed. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	OnPropertiesApplied	(Inherited from Xceed.FileSystem.FileSystemEventsSession)
	OnReadingZipItemCompletion	The last ReadingZipItemProgression event raised once processing is completed.
	OnReadingZipItemProgression	Raises the ReadingZipItemProgression event.
	OnScanningFolder	Raises the Xceed.FileSystem.FileSystemEvents.ScanningFolder event. (Inherited from Xceed.FileSystem.FileSystemEventsSession)
	OnUndoBytesProcessed	Overloaded. Removes the amount of bytes processed for an item if an error occurred during the processing of that item. (Inherited from Xceed.FileSystem.FileSystemEventsSession)

Top

Protected Methods

	Name	Description
	GetItemSize	(Inherited from Xceed.FileSystem.FileSystemEventsSession)

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.

Reference

ZipEventsSession Members
Xceed.Zip Namespace
FileSystemEventsSession Class

Send Feedback

Business Suite

Ultimate Suite

Reference