Class BatchProgressEventArgs

Properties of a progress event in a batch process

Inheritance
object
EventArgs
BatchProgressEventArgs
Inherited Members
Namespace: SdlSdl.FileTypeSupportFrameworkIntegrationApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public class BatchProgressEventArgs : EventArgs

Constructors

BatchProgressEventArgs(string, int, int, byte)

Construct with explicitly specified progress information.

Declaration
public BatchProgressEventArgs(string filePath, int fileNumber, int totalFiles, byte filePercentComplete)
Parameters
Type Name Description
string filePath

path to the file being processed
int fileNumber

file number in the batch, 0 is the first file
int totalFiles

total files in the batch
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
int

FilePath

Path of the file being processed

Declaration
public string FilePath { get; set; }
Property Value
Type Description
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
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
int

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
string
Overrides