TreeGetIndex (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Controls, pages and windows / TreeView functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

TreeGetIndex (Function)

In french: ArbreRécupèreIndice

Warning
From version 28 (75), TreeGetSubscript is kept for backward compatibility. This function has been replaced with TreeGetIndex.

Returns the index of an element (node or leaf) in a TreeView control.

Remark: For example, this function gets an index to call the properties of a row in a TreeView control with the following syntax:

TreeView_control[Index].<Property Name> = ...

Example

// Switch the leaf row to red
nIndex is int
nIndex = TreeGetIndex(TREE_TreeView1, "Root" + TAB + "Node" + TAB + "Leaf")
IF nIndex > 0 THEN
	// Checks whether the node is visible before using it
	IF TREE_TreeView1[nIndex] = -1 THEN 
		// The node is not visible: expand it to make it visible
		TreeExpand(TREE_TreeView1, "Root" + TAB + "Node" + TAB + "Leaf")
	END
	// Modifies its color
	TREE_TreeView1[nIndex].Color = DarkRed
END

Syntax

<Result> = TreeGetIndex(<TreeView control> , <Element path>)

<Result>: Integer

Index of the found element.
Caution: The node can be handled only if it is visible (which means if it is expanded).
-1 if the element does not exist.

<TreeView control>: Control name

Name of the TreeView control to be used.

<Element path>: Character string

Full path of the element to be used. This parameter has the following format:
"<Root name>" + TAB + ["<Name of 1st node>" + TAB + ...
["<Name of 2nd node>" + TAB + [...]]]"<Leaf name>"
If there are two elements with the same name in the path, you can add the IDs of the elements (after their names using TreeID).

Component: wd290obj.dll