ObjectDCL Banner

Tree_EditLabel Method

Description

This method starts the edit process of a tree item by displaying a text box on top of the 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.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the dialog is not found, the dialog does not support this function or the node is not found.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_Tree_EditLabel 
		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:

CopyCode imageCopy Code
(Odcl_Tree_EditLabel
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		Key [as String or Tree Node Handle])

Remarks

This method will not start the editing process if the EditLabel property of the control is set to False.

Applies For

TreeControl.

Example

CopyCode imageCopy Code
; Initiate editing tree item label
(Odcl_Tree_EditLabel MyProject_MyForm_MyControl "C_Documents and Settings")

See Also

Tree_CancelEditLabel, OnBeginLabelEdit (TreeControl), OnEditLabelItem (TreeControl)