Tree_ExpandItem Method
Description
This method expands any visible node item to display its children.
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.
- ExpandStyle
- Integer specifying the direction on the stack of controls to move the specified control.
- -1 (Collapses the tree branch)
- 0 (Toggles the tree branch from expanded to collapsed or collapsed to expanded)
- 1 (Expands the tree branch)
Return Values
Returns the following according to the situation:
- T when successful.
- Nil if the dialog is not found, the dialog does not support this function or the node is not found.
AutoLISP Syntax
The recommended convention is passing the control identifier directly:
Copy Code |
(Odcl_Tree_ExpandItem
MyControlReference [as Reference]
ParentKey [as String or Tree Node Handle]
ExpandStyle [as Integer]) |
An alternative convention is to identify the control by providing the project file, the dialog name and the control name:
Copy Code |
(Odcl_Tree_ExpandItem
ProjectFile [as String]
DialogName [as String]
ControlName [as String]
ParentKey [as String or Tree Node Handle]
ExpandStyle [as Integer]) |
Applies For
TreeControl.
Example
Copy Code |
; Expand a tree item
(Odcl_Tree_ExpandItem MyProject_MyForm_MyControl "C_Documents and Settings" 1) |
See Also
Tree_IsItemExpanded