EnsureVisible Method (TREEVIEW)


PLBCMP GUI Only

 

The EnsureVisible method moves a specified item in a TREEVIEW object into the visible area. The method uses the following format:

 

[label]

{object}.EnsureVisible

[GIVING {return}] USING [*Item=]{item}

 

Where:

label

Optional. A Program Execution Label.

object

Required. A TREEVIEW object that is accessed.

return

Optional. A Numeric Variable that indicates the success or failure of the method.

item

Required. A decimal number or Numeric Variable that indicates the handle of item to remain visible.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. {index} is an item handle indicating the item within the object to remain visible.

  2. The method expands the parent item or scrolls the list object's window as necessary.

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

  4.  

    Value

    Constant

    The method ...

    0

    $FALSE

    failed.

    1

    $TRUE

    was successful.

 

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

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

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

 

 

See Also: Method Syntax, TREEVIEW Methods

 



PL/B Language Reference DeleteItem Method (TREEVIEW) Expand Method (TREEVIEW)