Vicon Shogun banner

Description

Returns the enabled status of the user control that is specified by userControlID.

A control that is disabled is blocked from user input (mouse and keystrokes). It is also dimmed to indicate a disabled status.

Functional area

User Window

Command syntax

Syntax

getControlEnabled userControlID

Arguments

NameTypeRequiredComments
userControlIdintyesID of user control to get the enabled status for.

Flags

None

Return value

boolean

Examples

// Get the enabled status of a User Control.
int $windowId;
int $controlId;
boolean $isEnabled;

// First create a User Window to place the Control on
$windowId = `createWindow "MyWindow"`;
// Create a Push Button Control in the window. We will disable it
// after we create it.
$controlId = `createPushButton $windowId -text "Disabled"`;


// Disable the control
enableControl $controlId false;
// Now get the enabled status. Should be false.
$isEnabled = `getControlEnabled $controlId`;
print $isEnabled;

Additional information

Related commands