Tree_GetItemText Method
Description
This method gets the text of any 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 describing the label of the tree item.
- Nil if the control is not found, is not visible or there is no tree item.
AutoLISP Syntax
The recommended convention is passing the control identifier directly:
 Copy Code |
|---|
(Odcl_Tree_GetItemText 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:
| Copy Code |
|---|
(Odcl_Tree_GetItemText ProjectFile [as String] DialogName [as String] ControlName [as String] Key [as String or Tree Node Handle]) |
Applies For
Example
| Copy Code |
|---|
; Get the label of the tree item (Setq rValue (Odcl_Tree_GetItemText MyProject_MyForm_MyControl "C_Documents and Settings")) |
See Also
Tree_GetItem, Tree_GetItemData, Tree_GetItemImages, Tree_SetItemData, Tree_SetItemImages, Tree_SetItemText