ObjectDCL Banner

Tree_SetItemData Method

Description

This method sets an integer item data to 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.
ItemData
Integer specifying the application defined data to attach to the tree item

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 such item.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Tree_SetItemData 
		MyControlReference [as Reference]
		Key [as String or Tree Node Handle]
		ItemData [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_SetItemData
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		Key [as String or Tree Node Handle]
		ItemData [as Integer])

Applies For

TreeControl.

Example

CopyCode imageCopy Code
; Set the application defined item data
(Odcl_Tree_SetItemData MyProject_MyForm_MyControl "C_Documents and Settings" 10000)

See Also

Tree_GetItem, Tree_GetItemData, Tree_GetItemImages, Tree_GetItemText, Tree_SetItemImages, Tree_SetItemText