TreeExpandAll (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Node to expand
Selection bar

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

TreeExpandAll (Function)

In french: ArbreDérouleTout

Expands a node and all its child elements in a TreeView control.

Example of TreeView control:

Reminder: At run time, a node is expanded when the node name is preceded by "-".

Example

// Expand the "Desserts" node in the "TREE_RecipeTV" TreeView control
// All child elements are also expanded
Res = TreeExpandAll(TREE_RecipeTV, "Recipes" + TAB + "Desserts" )

Syntax

<Result> = TreeExpandAll(<TreeView control> [, <Node to expand>])

<Result>: Boolean

True if the node and its child elements have been expanded,
False otherwise.

<TreeView control>: Control name

Name of TreeView control to use.

<Node to expand>: Optional character string

Path of node to expand (as well as its child elements). This parameter has the following format:

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

If this parameter is not specified, the TreeView control is expanded from the root.
In case of duplicates on a path element, this path can contain the element identifier (specified at the end of its name by TreeID).

Remarks

Node to expand

If the node to expand:

is not found, TreeExpandAll returns False.
is not specified, TreeExpandAll returns True and the TreeView control is expanded from its root.
is a leaf, TreeExpandAll returns True.
is already expanded, TreeExpandAll returns True and the child elements are expanded if necessary.
is not visible, TreeExpandAll makes this node visible. Its "parent" and "sibling" elements are also displayed. The "parent" elements are expanded.

Versions 20 and later
During the call to TreeExpandAll, if the specified branch and/or its children include a procedure associated by ..AddChildDelayed, this procedure will be run.

New in version 20
During the call to TreeExpandAll, if the specified branch and/or its children include a procedure associated by ..AddChildDelayed, this procedure will be run.

During the call to TreeExpandAll, if the specified branch and/or its children include a procedure associated by ..AddChildDelayed, this procedure will be run.

Selection bar

TreeExpandAll does not modify the position of the selection bar.

Component : wd240obj.dll