SetCurSel Method (COMBOBOX / DATALIST)
PLBCMP GUI Only
The SetCurSel method highlights a string within the given DATALIST or COMBOBOX object. The method uses the following format:
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. A DATALIST or COMBOBOX object that is accessed.
return
Optional. A Numeric Variable that indicates the success or failure of the method.
index
Required. A decimal number or Numeric Variable that indicates the zero-based item to select.
Flags Affected: EOS, OVER, ZERO
Note the following:
The MULTISELECT property of the object must be cleared.
If another item was previously selected, its selection is removed.
{index} is a zero-based number indicating the item within the object to select. If {index} is -1, the action is applied to all items in the object.
Upon completion, {return} will contain the status of the method as follows. $TRUE and $FALSE are defined in PLBEQU.INC:
|
Value |
Constant |
The selection ... |
|
0 |
$FALSE |
failed. |
|
1 |
$TRUE |
was successful. |
If the value returned is zero, the ZERO Condition Flag is set.
The OVER and EOS Condition Flags are always cleared.
For improved performance in the Application Server environment, do not specify the optional return value unless needed.
See Also: Method Syntax, DATALIST Methods, COMBOBOX Methods
|
|