Tree_DeleteItem Method

Description

This method deletes any tree item and its children.

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:

Copy Code
(Odcl_Tree_DeleteItem 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:

Copy Code
(Odcl_Tree_DeleteItem ProjectFile [as String] DialogName [as String] ControlName [as String] Key [as String or Tree Node Handle])

Remarks

Warning: If the tree control was populated using String keys, this method may incorrectly re-order the internal key list so that String keys will not match the correct node items. This is a design flaw of the Microsoft Tree control and a work around has not be found.

Applies For

TreeControl.

Example

Copy Code
; Delete a tree item (Odcl_Tree_DeleteItem MyProject_MyForm_MyControl "C_Documents and Settings")