Show Progress Window
Verb: showProgress
Available from: <Standard>
Displays a window with a progress bar containing a maximum value, a current value, and a message.
Syntax
showProgress --text(String) --value(Numeric) --maximum(Numeric)
Inputs
| Script | Designer | Required | AcceptedTypes | Description |
|---|---|---|---|---|
| --text | Message | Required | Text | Message displayed in the progress window. |
| --value | Value | Required | Number | Current progress value displayed in the window. |
| --maximum | Maximum | Required | Number | Maximum progress value displayed in the window. |
Example
Command displays the progress window of a loop until its completion.
defVar --name startValue --type Numeric --value 0
defVar --name endValue --type Numeric --value 50
// Loop increments a variable from 0 to 50, by 1 on each loop.
while --left "${startValue}" --operator "Less_Than_Equal_To" --right "${endValue}"
incrementVar --number ${startValue}
showProgress --text "Wait for the while loop to end..." --value ${startValue} --maximum ${endValue}
delay --timeout 00:00:00.0500000
endWhile
// Closes the open progress window.
closeProgress
Remarks
Show Progress Window is used in conjunction with the Close Progress Window command, which closes the progress window when it is completed.