<TreeView>.Collapse (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Node to collapse
Selection bar

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<TreeView>.Collapse (Function)

In french: <Arbre>.Enroule

Collapses a branch that was expanded beforehand. The "child" nodes are no longer visible in the TreeView control. Child nodes remain in their previous status (collapsed or expanded).

Example of TreeView control:

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

Example

// Collapse the "Desserts" node in the "TREE_RecipeTV" TreeView control
Res = TREE_RecipeTV.Collapse("Recipes" + TAB + "Desserts")

Syntax

<Result> = <TreeView control>.Collapse(<Node to collapse>)

<Result>: Boolean

True if the node was collapsed,
False otherwise.

<TreeView control>: Control name

Name of TreeView control to use.

<Node to collapse>: Character string

Path of node to collapse. This parameter has the following format:

"<Name of root>" + 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).

Remarks

Node to collapse

If the node to collapse:

is not found, <TreeView>.Collapse returns False.
is a leaf, <TreeView>.Collapse returns True.
is already collapsed, <TreeView>.Collapse returns True.

Selection bar

If the selection bar was positioned on one of the elements of the node to collapse, the bar is positioned on the collapsed node after the call to <TreeView>.Collapse.
The modification code is called whenever the selection bar is moved. If two levels are collapsed and if the selection bar is positioned on the higher node, the modification codes of each level are run.
The full path of the selected element is returned by <Tree>.Select.

Component: wd260obj.dll