SetTopIndex Method (COMBOBOX / DATALIST)
PLBCMP GUI Only
The SetTopIndex method ensures that a specified item appears at the top of the DATALIST or COMBOBOX window. 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 positioned to the top of the window if possible.
Flags Affected: EOS, OVER, ZERO
Note the following:
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.
This method is not supported when using the PL/B Web Server.
See Also: Method Syntax, DATALIST Methods, COMBOBOX Methods
|
|