SelectItem Method (TREEVIEW)

PLBCMP GUI Only

The SelectItem method highlights the given TREEVIEW item, scrolls it into view, and redraws it. The method uses the following format:

[label]	{object}.SelectItem	[GIVING {return}] USING [Item=]{item*}:
		[Code=]{code*}

Where:

label

object

Required. A TREEVIEW object 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 the item to select.

code

Required. A decimal number or Numeric Variable that indicates an action from the table below.

Flags Affected: EOS, OVER, ZERO

Note the following:

{item} is an item handle indicating the item within the object to select.
{code} is a variable, literal or a constant as defined in PLBMETH.INC indicating one of the following actions:

Value	Constant	Action
0x9	TVGN_CARET	Sets the selection to the specified item. If the item is a child of a collapsed parent item, the parent's list is expanded to reveal the item.
0x8	TVGN_DROPHILITE	Redraws the given item in the style used to indicate the target of a drag-and-drop operation.
0x5	TVGN_FIRSTVISIBLE	Scrolls the object vertically making the specified item the first visible item.

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

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, TREEVIEW Methods