ObjectDCL Banner

Tree_SetExpandedImage Method

Description

This method assigns an image from the image list as the image to be displayed once 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.
ExpandedImageIndex
Integer specifying the index of an assigned image in the TreeControl's image list

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:

CopyCode imageCopy Code
(Odcl_Tree_SetExpandedImage 
		MyControlReference [as Reference]
		Key [as String or Tree Node Handle]
		ExpandedImageIndex [as Integer])

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_SetExpandedImage
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		Key [as String or Tree Node Handle]
		ExpandedImageIndex [as Integer])

Remarks

If a node item does not have a String key assigned to it, it will not have an expanded image.

Applies For

TreeControl.

Example

CopyCode imageCopy Code
; Set the index of the new expanded image
(Odcl_Tree_SetExpandedImage MyProject_MyForm_MyControl 10)

See Also

Tree_GetExpandedImage