SetCaretIndex Method (DATALIST)
PLBCMP GUI Only
The SetCaretIndex method moves the focus rectangle to a specified item in a multiple-selection DATALIST object. The method uses the following format:
|
|
|
|
Where:
label
Optional. A Program Execution Label.
object
Required. A DATALIST 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 receive the caret.
Flags Affected: EOS, OVER, ZERO
Note the following:
If the item is not completely visible, the window is scrolled.
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.
When using the PL/B Web Server, this method is not supported.
See Also: Method Syntax, DATALIST Methods
|
|