SetItemCheck Method (TREEVIEW)
PLBCMP GUI Only
The SetItemCheck method alters the checked state for a specified item in a TREEVIEW object. The method uses the following format:
|
|
|
|
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. A TREEVIEW object that is accessed.
return
Optional. A Numeric Variable that indicates the success or failure of the method.
item
Required. A decimal number or Numeric Variable that indicates the handle of the item to access in the TREEVIEW..
value
Required. A decimal number or Numeric Variable that specifies the checkbox's state.
Flags Affected: EOS, OVER, ZERO
Note the following:
{item} is a handle indicating the item within the object to access.
{value} is a one (1) to set the checkmark or a zero (0) to clear the checkmark.
If the value returned is zero, the ZERO condition flag is set.
The OVER and EOS Condition Flags are always cleared.
The CHECKBOX property must be set to $ON for the object.
Upon completion, {return} will contain the status of the modification as follows. $TRUE and $FALSE are defined in PLBEQU.INC.
|
Value |
Constant |
The modification ... |
|
0 |
$FALSE |
failed. |
|
1 |
$TRUE |
was successful. |
For improved performance in the Application Server environment, do not specify the optional return value unless needed.
See Also: Method Syntax, TREEVIEW Methods
|
|