Progress Event

Fired while data is being read from or written into a zip file.

Syntax

Visual Basic
C#

'Declaration
 
Public Event Progress As ZipProgressEventHandler

public event ZipProgressEventHandler Progress

Event Data

The event handler receives an argument of type ZipProgressEventArgs containing data related to this event. The following ZipProgressEventArgs properties provide information specific to this event.

Property	Description
Cancel	Set to true to cancel the current operation.
FileLength	Gets the length of the file being compressed or expanded.
FileLengthLong	Gets the length of the file being compressed or expanded.
FileName	Gets the name of the file being compressed or expanded.
Position	Gets the current position into the stream.
PositionLong	Gets the current position into the stream.

Remarks

This event is typically used to update the application UI during lengthy operations. It can also be used to cancel the operations.

Example

The code below writes messages to the output window while the application compresses files.

void Compress()
{
	// create zip file
	C1Zip zip = new C1Zip();
	zip.Create(zipFileName);
             
	// connect event handler
	zip.Progress += new ZipProgressEventHandler(zip_Progress);
             
	// add files
	foreach (string fileName in Directory.GetFiles(path, "*.*"))
		zip.Entries.Add(fileName);
}
             
// print messages while files are compressed
void zip_Progress(object sender, ZipProgressEventArgs e)
{
	Console.WriteLine("Compressing {0}, {1:p0} done",
		e.FileName, e.Position/(float)e.FileLength);
}

Reference

C1ZipFile Class
C1ZipFile Members