EnsureVisible Method (LISTVIEW)

PLBCMP GUI Only

The EnsureVisible method forces a specified item in a LISTVIEW object into the visible area. 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 indicates the success or failure of the method.

index

Required. A decimal number or Numeric Variable that indicates the zero-based item or row that is made visible.

partial

Required. A decimal number or Numeric Variable that alters the visibility as described below.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. The method expands the parent item or scrolls the LISTVIEW window as necessary.

2. {index} must be a valid row number within the LISTVIEW or the operation is ignored.

3. {partial} is a decimal number, numeric variable or constant that alters the visibility as follows. $TRUE and $FALSE are defined in PLBEQU.INC.

 

Value	Constant	The item ...
0	$FALSE	must be completely visible.
1	$TRUE	may be partially visible.

4. Upon completion, {return} will contain the status of the method as follows. $TRUE and $FALSE are defined in PLBEQU.INC.

 

Value	Constant	The method ...
0	$FALSE	failed.
1	$TRUE	was successful.

5. If the value returned is zero, the ZERO Condition Flag is set.

6. The OVER and EOS Condition Flags are always cleared.

7. For improved performance in the Application Server environment, do not specify the optional return value unless needed.

See Also: Example Code, Method Syntax, LISTVIEW Methods