Description

Sets the check value of the check box user control that is specified by userControlId.

Because check boxes can be created with the triState flag (the third state being "indeterminate"), either a Boolean or an integer is accepted for checkVal.

Functional area

User Window

Command syntax

Syntax

setCheckBoxCheck userControlID check

Arguments

Name	Type	Required	Comments
`checkVal`	int	yes	0 to uncheck the control, 1 to check it, or 2 to set it to indeterminate
`userControlId`	int	yes	ID of User Control to operate on.

Flags

None

Return value

void

Examples

// Set the checked value of a Check Box User Control
int $windowId;
int $controlId;
int $checked;
 
// First create a User Window to place the Control on
$windowId = `createWindow "MyWindow"`;
 
// Create the User Control on the Window. 
$controlId = `createCheckBox $windowId -triState`;
 
// Set the value to "indeterminate"
setCheckBoxCheck $controlId 2;
 
// Get the value on the Check Box. 
$checked = `getCheckBoxCheck $controlId`;
if( $checked == 1 )
{ 
    print "Checked";
}
else if( $checked == 0 )
{
    print "Unchecked";
}
else
{
    print "Indeterminate";
}

Shogun 1.7 Documentation

setCheckBoxCheck