-
Notifications
You must be signed in to change notification settings - Fork 4
IProgressInfo
An object representing a visible progress indicator.
NOTE: When a plugin callback includes an IProgressInfo parameter, the callback will be run in a separate thread.
bool CancelRequested
Gets whether the user has requested to cancel the operation.
NOTE: If this happens, Paratext may end the thread in which the plugin work is being done after waiting 1 second. So the plugin should check this regularly and respond in a timely fashion if any action is necessary.
string Message
Sets a (localized) message indicating the current operation. Keep it short!
int Value
Gets or sets the current value representing the progress of the task.
NOTE: If a value is given which is less than the minValue specified in Initialize, the value will be set to that minValue. If a value is given which is greater than the maxValue specified in Initialize, the value will be set to that maxValue.
void Initialize(string message, int maxValue, int minValue=0)
Initializes the progress object. Value will be set to minValue .
| Parameter | Description |
|---|---|
| message | A (localized) message indicating the current operation. Keep it short! |
| maxValue | The value representing completion of the task. |
| minValue | The value representing the start of the task. |
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | maxValue is less than or equal to minValue |
This page is auto-generated. User edits will be lost when regenerated.