Method | Description | |
---|---|---|
Dispose ( ) : void | ||
Report ( int percent ) : void | ||
Report ( int percent, string statusMessage ) : void | ||
Report ( int percent, string statusMessage, MessageType type ) : void | ||
ReportException ( |
||
ReportStatus ( string statusMessage ) : void | ||
ReportStatus ( string statusMessage, MessageType type ) : void | ||
ReportTransientStatus ( string statusMessage ) : void | ||
SubtaskProgressStatus ( string taskName, IProgressStatus mainTask, int subtaskIndex, int subtaskCount ) : System |
Default constructor. Automatically manages transient status for you.
|
|
SubtaskProgressStatus ( string taskName, IProgressStatus mainTask, int subtaskIndex, int subtaskCount, bool automaticTransientStatus ) : System |
Default constructor
|
Method | Description | |
---|---|---|
InitializeStatus ( ) : void | ||
SetProgress ( int taskProgress ) : void | ||
SetRangeTaskProgress ( int startPercentage, int endPercentage, int taskPercent ) : void |
Sets the progress of the whole based on the progress within a percentage range of the main progress (e.g. 0-100% of a task within the global range of 0-20%)
|
|
SetTaskProgress ( int taskNumber, int totalTasks, int taskPercent ) : void |
Sets the progress of the whole based on the progress within a sub-task of the main progress (e.g. 0-100% of a task within the global range of 0-20%)
|
public Report ( int percent, string statusMessage ) : void | ||
percent | int | |
statusMessage | string | |
return | void |
public Report ( int percent, string statusMessage, MessageType type ) : void | ||
percent | int | |
statusMessage | string | |
type | MessageType | |
return | void |
public ReportException ( |
||
exception | ||
return | void |
public ReportStatus ( string statusMessage ) : void | ||
statusMessage | string | |
return | void |
public ReportStatus ( string statusMessage, MessageType type ) : void | ||
statusMessage | string | |
type | MessageType | |
return | void |
public ReportTransientStatus ( string statusMessage ) : void | ||
statusMessage | string | |
return | void |
public SubtaskProgressStatus ( string taskName, IProgressStatus mainTask, int subtaskIndex, int subtaskCount ) : System | ||
taskName | string | Name of the subtask to run |
mainTask | IProgressStatus | The progress status of the main task (or parent subtask) |
subtaskIndex | int | The index of this subtask among total subtask count (used to calculate offset progress) |
subtaskCount | int | The total number of subtasks in the main task (or parent subtask) |
return | System |
public SubtaskProgressStatus ( string taskName, IProgressStatus mainTask, int subtaskIndex, int subtaskCount, bool automaticTransientStatus ) : System | ||
taskName | string | Name of the subtask to run |
mainTask | IProgressStatus | The progress status of the main task (or parent subtask) |
subtaskIndex | int | The index of this subtask among total subtask count (used to calculate offset progress) |
subtaskCount | int | The total number of subtasks in the main task (or parent subtask) |
automaticTransientStatus | bool | If true, transient status will be automatically managed for you for this subtask ($taskname running for xx seconds). Make sure to dispose the subtask! |
return | System |