ObjectDCL Banner

Tree_GetFirstChildItem Method

Description

This method gets the key of the first child 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:

  • String or Tree Node Handle if there is a first child to the tree item.
  • Nil if the control is not found, is not visible or there is no child.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Tree_GetFirstChildItem 
		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_GetFirstChildItem
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		Key [as String or Tree Node Handle])

Applies For

TreeControl.

Example

CopyCode imageCopy Code
; Get the key of the first child
(Setq rValue (Odcl_Tree_GetFirstChildItem MyProject_MyForm_MyControl "C_Documents and Settings"))

See Also

Tree_GetNextSiblingItem, Tree_GetParent, Tree_GetPrevSiblingItem, Tree_GetRootItem