ObjectDCL Banner

Tree_SetItemText Method

Description

This method sets the label 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.
Text
String specifying the new label to apply

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

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Tree_SetItemText 
		MyControlReference [as Reference]
		Key [as String or Tree Node Handle]
		Text [as String])

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

Applies For

TreeControl.

Example

CopyCode imageCopy Code
; Set the label of the tree item
(Odcl_Tree_SetItemText MyProject_MyForm_MyControl "C_Documents and Settings" "Documents and Settings")

See Also

Tree_GetItem, Tree_GetItemData, Tree_GetItemImages, Tree_GetItemText, Tree_SetItemData, Tree_SetItemImages