ObjectDCL Banner

Tree_SelectItem Method

Description

This method selects the indicated tree item.

Parameters

MyControlReference
Reference to the control in the form of MyProject_MyForm_MyControl.
ProjectFile
String identifying the project as it was passed in LoadProject.
DialogName
String identifying the dialog by name.
ControlName
String identifying the control by name.
Key
String specifying the a unique key in the tree structure identifying the tree node.
Tree Node Handle specifying the tree node uniquely.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the dialog is not found, the control is not found or not visible or the tree item is not found.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Tree_SelectItem 
		MyControlReference [as Reference]
		Key [as String or Tree Node Handle])

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

CopyCode imageCopy Code
(Odcl_Tree_SelectItem
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		Key [as String or Tree Node Handle])

Applies For

TreeControl.

Example

CopyCode imageCopy Code
; Select this item
(Odcl_Tree_SelectItem MyProject_MyForm_MyControl "C_Program Files")

See Also

Tree_GetSelectedItem, Tree_SelectSetFirstVisible