Class FastZipEvents

FastZipEvents supports all events applicable to FastZip operations.

Inheritance
System.Object
FastZipEvents
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: ICSharpCode.SharpZipLib.Zip
Assembly: ICSharpCode.SharpZipLib.dll
Syntax
public class FastZipEvents

Fields

| Improve this Doc View Source

CompletedFile

Delegate to invoke when processing for a file has been completed.

Declaration
public CompletedFileHandler CompletedFile
Field Value
Type Description
CompletedFileHandler
| Improve this Doc View Source

DirectoryFailure

Delegate to invoke when processing directory failures.

Declaration
public DirectoryFailureHandler DirectoryFailure
Field Value
Type Description
DirectoryFailureHandler
| Improve this Doc View Source

FileFailure

Delegate to invoke when processing file failures.

Declaration
public FileFailureHandler FileFailure
Field Value
Type Description
FileFailureHandler
| Improve this Doc View Source

ProcessFile

Delegate to invoke when processing files.

Declaration
public ProcessFileHandler ProcessFile
Field Value
Type Description
ProcessFileHandler
| Improve this Doc View Source

Progress

Delegate to invoke during processing of files.

Declaration
public ProgressHandler Progress
Field Value
Type Description
ProgressHandler

Properties

| Improve this Doc View Source

ProgressInterval

The minimum timespan between Progress events.

Declaration
public TimeSpan ProgressInterval { get; set; }
Property Value
Type Description
System.TimeSpan

The minimum period of time between Progress events.
Remarks

The default interval is three seconds.

See Also

Methods

| Improve this Doc View Source

OnCompletedFile(String)

Fires the CompletedFile delegate

Declaration
public bool OnCompletedFile(string file)
Parameters
Type Name Description
System.String file

The file whose processing has been completed.
Returns
Type Description
System.Boolean

A boolean indicating if execution should continue or not.
| Improve this Doc View Source

OnDirectoryFailure(String, Exception)

Raise the directory failure event.

Declaration
public bool OnDirectoryFailure(string directory, Exception e)
Parameters
Type Name Description
System.String directory

The directory causing the failure.
System.Exception e

The exception for this event.
Returns
Type Description
System.Boolean

A boolean indicating if execution should continue or not.
| Improve this Doc View Source

OnFileFailure(String, Exception)

Fires the file failure handler delegate.

Declaration
public bool OnFileFailure(string file, Exception e)
Parameters
Type Name Description
System.String file

The file causing the failure.
System.Exception e

The exception for this failure.
Returns
Type Description
System.Boolean

A boolean indicating if execution should continue or not.
| Improve this Doc View Source

OnProcessDirectory(String, Boolean)

Fires the process directory delegate.

Declaration
public bool OnProcessDirectory(string directory, bool hasMatchingFiles)
Parameters
Type Name Description
System.String directory

The directory being processed.
System.Boolean hasMatchingFiles

Flag indicating if the directory has matching files as determined by the current filter.
Returns
Type Description
System.Boolean

A System.Boolean of true if the operation should continue; false otherwise.
| Improve this Doc View Source

OnProcessFile(String)

Fires the ProcessFile delegate.

Declaration
public bool OnProcessFile(string file)
Parameters
Type Name Description
System.String file

The file being processed.
Returns
Type Description
System.Boolean

A boolean indicating if execution should continue or not.

Events

| Improve this Doc View Source

ProcessDirectory

Delegate to invoke when processing directories.

Declaration
public event EventHandler<DirectoryEventArgs> ProcessDirectory
Event Type
Type Description
System.EventHandler<DirectoryEventArgs>