ObjectDCL Banner

Tree_SetItemImages Method

Description

This method sets the unselected and selected images 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.
ImageIndex
Integer identifying the index of the assigned image in the TreeControl's image list for the default state.
SelectedImageIndex
Integer identifying the index of the assigned image in the TreeControl's image list for the selected state.

Return Values

Returns the following according to the situation:

  • T when successful.
  • 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:

CopyCode imageCopy Code
(Odcl_Tree_SetItemImages 
		MyControlReference [as Reference]
		Key [as String or Tree Node Handle]
		ImageIndex [as Integer]
		[Optional] SelectedImageIndex [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_SetItemImages
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		Key [as String or Tree Node Handle]
		ImageIndex [as Integer]
		[Optional] SelectedImageIndex [as Integer])

Applies For

TreeControl.

Example

CopyCode imageCopy Code
; Set the new image index to give this tree item a distinct look
(Odcl_Tree_SetItemImages MyProject_MyForm_MyControl "C_Documents and Settings" 5)

See Also

Tree_GetItem, Tree_GetItemData, Tree_GetItemImages, Tree_GetItemText, Tree_SetItemData, Tree_SetItemText