Tree_InsertAfter Method

Description

This method adds a child tree item or top level tree item after an indicated tree a child tree item or top level.

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.
ReferenceKey: String specifying the a unique key in the tree structure identifying the reference tree node.; Tree Node Handle specifying the tree node uniquely.
Text: String specifying the label of the tree node.
Key: String specifying the unique key in the tree structure for the new sibling tree node.
ImageIndex: Integer specifying the index of an assigned image in the TreeControl's image list.
SelectedImageIndex: Integer specifying the index of an assigned image in the TreeControl's image list.
ExpandedImageIndex: Integer specifying the index of an assigned image in the TreeControl's image list.

Return Values

Returns the following according to the situation:

Tree node handle that is used to identify the tree item just added. This value is used in later calls to identify which tree item to modify or query. So for example if you wish to change the text you would pass the handle pass back by Tree_AddChild into Tree_SetItemText to identify which child tree item to modify.
Nil if the dialog is not found, the dialog does not support this function or the parent node is not found.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

Copy Code
(Odcl_Tree_InsertAfter MyControlReference [as Reference] ReferenceKey [as String or Tree Node Handle] Text [as String] [Optional] Key [as String] [Optional] ImageIndex [as Integer] [Optional] SelectedImageIndex [as Integer] [Optional] ExpandedImageIndex [as Integer])

Copy Code

(Odcl_Tree_InsertAfter 
		MyControlReference [as Reference]
		ReferenceKey [as String or Tree Node Handle] 
		Text [as String] 
		[Optional] Key [as String]
		[Optional] ImageIndex [as Integer]
		[Optional] SelectedImageIndex [as Integer]
		[Optional] ExpandedImageIndex [as Integer])

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

Copy Code
(Odcl_Tree_InsertAfter ProjectFile [as String] DialogName [as String] ControlName [as String] ReferenceKey [as String or Tree Node Handle] Text [as String] [Optional] Key [as String] [Optional] ImageIndex [as Integer] [Optional] SelectedImageIndex [as Integer] [Optional] ExpandedImageIndex [as Integer])

Copy Code

(Odcl_Tree_InsertAfter
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		ReferenceKey [as String or Tree Node Handle] 
		Text [as String] 
		[Optional] Key [as String]
		[Optional] ImageIndex [as Integer]
		[Optional] SelectedImageIndex [as Integer]
		[Optional] ExpandedImageIndex [as Integer])

Remarks

Please specify a key when adding tree nodes in order to have expanded images.

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
; Populate tree (Odcl_Tree_InsertAfter MyProject_MyForm_MyControl "C_Documents and Settings" "Program Files" "C_Program Files" )