ReadProgress Event

DotNetZip

previous page next page

Ionic Zip Library v1.9.1.6 ReadProgress Event

An event handler invoked before, during, and after the reading of a zip archive.

Declaration Syntax

Visual Basic

Visual C++

public event EventHandler<ReadProgressEventArgs> ReadProgress

Public Event ReadProgress As EventHandler(Of ReadProgressEventArgs)

public:
 event EventHandler<ReadProgressEventArgs^>^ ReadProgress {
	void add (EventHandler<ReadProgressEventArgs^>^ value);
	void remove (EventHandler<ReadProgressEventArgs^>^ value);
}

Remarks

Depending on the particular event being signaled, different properties on the ReadProgressEventArgs parameter are set. The following table summarizes the available EventTypes and the conditions under which this event handler is invoked with a ReadProgressEventArgs with the given EventType.

value of EntryType	Meaning and conditions
ZipProgressEventType.Reading_Started	Fired just as ZipFile.Read() begins. Meaningful properties: ArchiveName.
ZipProgressEventType.Reading_Completed	Fired when ZipFile.Read() has completed. Meaningful properties: ArchiveName.
ZipProgressEventType.Reading_ArchiveBytesRead	Fired while reading, updates the number of bytes read for the entire archive. Meaningful properties: ArchiveName, CurrentEntry, BytesTransferred, TotalBytesToTransfer.
ZipProgressEventType.Reading_BeforeReadEntry	Indicates an entry is about to be read from the archive. Meaningful properties: ArchiveName, EntriesTotal.
ZipProgressEventType.Reading_AfterReadEntry	Indicates an entry has just been read from the archive. Meaningful properties: ArchiveName, EntriesTotal, CurrentEntry.