<TreeView>.Expand (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

Expand

Presentation

Example

Node to expand

Selection bar

See also

<TreeView>.Expand (Function)

In french: <Arbre>.Déroule

Expands a node in a TreeView control. The "child" elements (nodes or leaves) of this node become visible.

Example of TreeView control:

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

Example

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

Syntax

<Result> = <TreeView control>.Expands(<Node to expand>)

<Result>: Boolean

True if the node was expanded,
False otherwise.

<TreeView control>: Control name

Name of the TreeView control to be used.

<Node to expand>: Character string

Path of node to expand. 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).

Remarks

Node to expand

If the node to expand:

is not found, <TreeView>.Expand returns False.
is a leaf, <TreeView>.Expand returns True.
is already expanded, <TreeView>.Expand returns True.
is not visible, <TreeView>.Expand makes this node visible. Its "parent" and "sibling" elements are also displayed. The "parent" elements are expanded.

When <TreeView>.Expand is called, if the specified branch has a procedure associated via the AddChildDelayed property, this procedure will be executed.

Selection bar

<TreeView>.Expand does not change the position of the selection bar.

Component: wd280obj.dll