<TreeView>.Sort (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

TreeView functions

Prefix syntax

Sort

Presentation

Example

See also

<TreeView>.Sort (Function)

In french: <Arbre>.Trie

Sorts the elements found in a TreeView control.

Example of TreeView control:

Example

// Sort the elements found in the "TREE_TVRecipe" TreeView control
// Alphabetical sort from the "Desserts" node
Res = TREE_TVRecipe.Sort("Recipes" + TAB + "Desserts", tvUp)

Syntax

<Result> = <TreeView control>.Sort([<Path of source element> [, <Type of sort>]])

<Result>: Boolean

True if the sort was performed,
False if the specified source element does not exist.
After the call to <TreeView>.Sort, all the branches of the TreeView control are automatically collapsed.

<TreeView control>: Control name

Name of TreeView control to sort.

<Path of source element>: Optional character string

Full path of element from which the sort will be performed. If this parameter corresponds to the NULL constant or if it is not specified, the sort is performed on all elements found in the TreeView control. This parameter has the following format:

"<Root name>" + TAB + ["<Name of 1st node>" + TAB + ...
["<Name of 2nd node>" + TAB + [...]]]"<Leaf name>"

In case of duplicates on a path element, this path can contain the element identifier (specified at the end of its name by TreeID).

<Type of sort>: Optional constant

Type of sort to perform.
tvDown Sort in reverse alphabetical order.
tvUp
(Default value) Sort in alphabetical order.

Component: wd280obj.dll