From version 17
, this function is kept for backward compatibility. This function is replaced with TreeMapSeek
Finds the subscript of an element in a TreeMap control from the element path. This path was specified in TreeMapAdd
// The TMAP_Wine control is filled from a table.
// Find the element corresponding to the selected element in the table
SelectionPath is string
SelectionPath = COL_WineType[TABLE_WINE] + "\" + COL_Owner[TABLE_WINE]
ElementSubscript = TreeMapSearch(TMAP_Wine, SelectionPath)
// Select the element in the TreeMap control
IF ElementIndex <> - 1 THEN
TMAP_Wine = ElementIndex
<Result> = TreeMapSearch(<TreeMap control> , <Element path> [, <Start index>])
Remark: The element found can be handled directly using its index. You can for example modify the properties of this element or select it in the TreeMap control.
- Index of the element found.
- -1 if no element corresponds to the search.
<TreeMap control>: Control name
Name of the TreeMap control used.
If this parameter corresponds to an empty string (""), the TreeMap control to which the current process belongs will be used.
<Element path>: Character string
Path and caption of the sought element. This path must be identical to the one used when the element was added into the TreeMap control by TreeMapAdd.
The separator of different path elements can be:
- the "\" character. For example: "MyDirectory\MyFile".
- the "TAB" character. For example: "Desserts"+TAB+"Ice cream".
<Start index>: Optional integer
Index of the element from which the search will be performed. If this parameter is not specified, the search is performed in the entire TreeMap control. This parameter is used to find all the occurrences of a path.