Progress.IsEnabled

OverviewExamples

boolean Progress.IsEnabled (

string ObjectName )

Description

Returns true if a specific progress object is enabled, or false if it's disabled.

Note: When a progress object is disabled, it doesn't respond to the user at all.

Parameters

ObjectName

(string) The name of the progress object.

Returns

(boolean) True if the progress object is enabled, false if it is disabled. If an error occurs, false will be returned. You can use Application.GetLastError to determine whether this action failed, and why.

ResultVariable

When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.