Show / Hide Table of Contents

Class ProgressEventArgs

Event arguments during processing of a single file or directory.

Inheritance
System.Object
System.EventArgs
ProgressEventArgs
Inherited Members
System.EventArgs.Empty
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.Core
Assembly: ICSharpCode.SharpZipLib.dll
Syntax
public class ProgressEventArgs : EventArgs

Constructors

| Improve this Doc View Source

ProgressEventArgs(String, Int64, Int64)

Initialise a new instance of ScanEventArgs

Declaration
public ProgressEventArgs(string name, long processed, long target)
Parameters
Type Name Description
System.String name

The file or directory name if known.

System.Int64 processed

The number of bytes processed so far

System.Int64 target

The total number of bytes to process, 0 if not known

Properties

| Improve this Doc View Source

ContinueRunning

Get set a value indicating whether scanning should continue or not.

Declaration
public bool ContinueRunning { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Name

The name for this event if known.

Declaration
public string Name { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PercentComplete

Get a percentage representing how much of the Target has been processed

Declaration
public float PercentComplete { get; }
Property Value
Type Description
System.Single

0.0 to 100.0 percent; 0 if target is not known.

| Improve this Doc View Source

Processed

The number of bytes processed so far

Declaration
public long Processed { get; }
Property Value
Type Description
System.Int64
| Improve this Doc View Source

Target

The number of bytes to process.

Declaration
public long Target { get; }
Property Value
Type Description
System.Int64
Remarks

Target may be 0 or negative if the value isnt known.

  • Improve this Doc
  • View Source
In This Article
Back to top Copyright © 2000-2022 SharpZipLib Contributors