Description

Returns the visibility of the user control that is specified by userControlID.

All user controls are visible by default, unless created with the -hidden option.

Functional area

User Window

Command syntax

Syntax

getControlVisibility userControlID

Arguments

Name	Type	Required	Comments
`userControlId`	int	yes	ID of user control to get visibility for.

Flags

None

Return value

boolean

Examples

// Get the visibility of a control.
int $windowId;
int $controlId;
boolean $isShowing;
 
// First create a User Window to place the Control on
$windowId = `createWindow "MyWindow"`;
 
// Create a Push Button Control in the window. Create it hidden.
$controlId = `createPushButton $windowId -text "Sample" -hidden`;
 
// Get the visibility
$isShowing = `getControlVisibility $controlId`;
print $isShowing;

Shogun 1.9 Documentation

getControlVisibility