→ Varies
Collection
ProgressItem
Collection of Progress Item properties and methods to pause, resume and cancel progress items.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| static | String | readonly | Event object for progress item cancelled. |
| static | String | readonly | Event object for progress item title changed. |
| static | String | readonly | Event object for progress item value changed. |
| static | Number | readonly | Cancelled progress state. |
| static | Number | readonly | Failed progress state. |
| static | Number | readonly | Normal progress state. |
| static | Number | readonly | Paused progress state. |
| static | Number | readonly | Resumed progress state. |
| static | Number | readonly | Waiting progress state. |
| Varies | readonly | ||
| Object | readonly | Get the ID of the Progress Item. |
Methods
→ Boolean
Cancel the job being reported by this progress item
→ Varies
→ Number
Get the maximum progress value of the progress item.
→ Number
Get the progress state of the progress item.
→ String
Get the status message of the progress item.
→ String
Get the title of the progress item.
→ Number
Get the progress value of the progress item.
→ Boolean
Check whether the progress item has finished executing.
→ Boolean
Check if the progress item has started execution but not yet complete.
→ Boolean
Check if the progress item has been configured as unknown progress.
→ Boolean
Check if the progress item is waiting to start or has started but not yet complete.
→ Boolean
Pause or resume the progress job based on the state provided.
inProgresState
Number
→ Varies
→ Boolean
Set the tooltip for the cancel button of the progress item.
toolTip
String
→ Boolean
Set the progress state for the progress item.
state
Number
→ Boolean
Set the progress value and maximum value for the progress item.
→ Boolean
Set the progress value maximum value status message and tooltip for the progress item.
→ Boolean
Set the status message for the progress item.
statusMessage
String
→ Boolean
Set the title for the progress item.
title
String
→ Boolean
Set the tooltip for the progress item.
toolTip
String
→ Boolean
Set the type for the progress item.
type
Guid
→ Boolean
Set the progress item to unknown progress state.
statusMessage
String
→ Boolean
Propagates the given event on this object.
eventKey
String
→ Boolean
Check if the progress item can be cancelled.
→ Boolean
Check if the progress item can be paused|resumed.