Tree_GetRootItem Method
Description
This method retrieves the key of the first parent 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.
Return Values
Returns the following according to the situation:
- String or Tree Node Handle if there is such a 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:
 Copy Code |
|---|
(Odcl_Tree_GetRootItem MyControlReference [as Reference]) |
An alternative convention is to identify the control by providing the project file, the dialog name and the control name:
| Copy Code |
|---|
(Odcl_Tree_GetRootItem ProjectFile [as String] DialogName [as String] ControlName [as String]) |
Applies For
Example
| Copy Code |
|---|
; Get the key of the root item (Setq rValue (Odcl_Tree_GetRootItem MyProject_MyForm_MyControl "C_Documents and Settings")) |
See Also
Tree_GetFirstChildItem, Tree_GetNextSiblingItem, Tree_GetPrevSiblingItem