SetItemCheck Method (LISTVIEW)
PLBCMP GUI Only
The SetItemCheck method alters the checked state for a specified item in a LISTVIEW object. The method uses the following format:
|
|
|
|
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. A LISTVIEW object that is accessed.
return
Optional. A Numeric Variable that specifies the item's check state.
index
Required. A decimal number or Numeric Variable that specifies the zero-based item or row accessed.
value
Required. A decimal number or Numeric Variable that specifies the new state.
Flags Affected: EOS, OVER, ZERO
Note the following:
{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
If the {index} is specified with a '-1' value, the check {value} is applied to all of the items in the LISTVIEW object..
See Also: Method Syntax, LISTVIEW Methods
|
|