This document covers the following topics:
A progress indicator is used to inform the user about the progress of a
time consuming operation. A plug-in can create a progress indicator with the
method INatAutoStudio::ProgressIndicator.
The following properties are available:
Used to navigate to the parent interface of this interface.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| HANDLE OF OBJECT | VT_DISPATCH (INatAutoStudio) | Get only |
Used to navigate to the root interface.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| HANDLE OF OBJECT | VT_DISPATCH (INatAutoStudio) | Get only |
The text to be displayed in the status bar. This property is used with progress indicators of style status bar and gradient bar.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| A | VT_BSTR | Put only |
The text to be displayed in the gradient bar. This property is used with progress indicators of style gradient bar.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| A | VT_BSTR | Put only |
The text to be displayed in the animated dialog. This property is used with progress indicators of style Dialog.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| A | VT_BSTR | Put only |
Indicates if the user has pressed the ESC key or (in case of a progress indicator of style Dialog) the button, in order to abort the operation.
| Natural Data Format | Variant Type | Remark |
|---|---|---|
| L | VT_BOOL | Get only |
The following methods are available:
Starts the progress indicator.
Advances the progress indicator.
| Name | Natural Data Format | Variant Type | Remark |
|---|---|---|---|
| Steps | I4 | VT_I4 |
The number of steps to advance.
Terminates the progress indicator.
Stops running the animation that was assigned to the progress indicator when it was created. The animation can be resumed again by calling PlayAnimation.
Continues running the animation that was assigned to the progress indicator when it was created. The animation can be stopped by calling StopAnimation.
