Tree_GetExpandedImage Method
Description
This method retrieves the index of an assigned image in the TreeControl's image list that is to be the image to be displayed once the tree item has been expanded.
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 index of an assigned image in the TreeControl's image list.
AutoLISP Syntax
The recommended convention is passing the control identifier directly:
 Copy Code |
|---|
(Odcl_Tree_GetExpandedImage 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_GetExpandedImage ProjectFile [as String] DialogName [as String] ControlName [as String] Key [as String or Tree Node Handle]) |
Remarks
If a node item does not have a String key assigned to it, it will not have an expanded image.
Applies For
Example
| Copy Code |
|---|
; Get the index of the expanded image (Setq rValue (Odcl_Tree_GetExpandedImage MyProject_MyForm_MyControl)) |