Class BatchProgressEventArgs

Properties of a progress event in a batch process

Inheritance

System.Object

System.EventArgs

BatchProgressEventArgs

Inherited Members

System.EventArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public class BatchProgressEventArgs : EventArgs

Constructors

BatchProgressEventArgs(String, Int32, Int32, Byte)

Construct with explicitly specified progress information.

Declaration

public BatchProgressEventArgs(string filePath, int fileNumber, int totalFiles, byte filePercentComplete)

Parameters

Type	Name	Description
System.String	filePath	path to the file being processed
System.Int32	fileNumber	file number in the batch, 0 is the first file
System.Int32	totalFiles	total files in the batch
System.Byte	filePercentComplete	percent completed for the current file in the batch

Properties

FileNumber

Zero-based index indicating the file number in the batch for the file being processed.

Declaration

public int FileNumber { get; set; }

Property Value

Type	Description
System.Int32

FilePath

Path of the file being processed

Declaration

public string FilePath { get; set; }

Property Value

Type	Description
System.String

FilePercentComplete

Value between 0 and 100 (inclusive) indicating the progress of the file currently being processed.

Declaration

public byte FilePercentComplete { get; set; }

Property Value

Type	Description
System.Byte

Remarks

Note that this is the percent completed for the current file only, NOT the percent completed for the batch.

TotalFiles

Total number of files in batch

Declaration

public int TotalFiles { get; set; }

Property Value

Type	Description
System.Int32

Methods

ToString()

For debugging purposes, shows the file number and the progress in a non-localized format.

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()