TreeListItem (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WLanguage procedure
Interrupting TreeListItem

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

TreeListItem (Function)

In french: In French: ArbreListeFils

Lists the "children" of a node and the "child" elements of these "children" in a TreeView control. A WLanguage procedure is called whenever a "child" element is found.

Example of TreeView control:

Example

See additional examples

// Lists the "children" of "Desserts" node in "TREE_RecipeTV" treeview
// The "ExpandAll" procedure is called
// for each "child" element found in the "Desserts" node
Res = TreeListItem(TREE_RecipeTV, "Recipes" + TAB + "Desserts", "ExpandAll")

Syntax

<Result> = TreeListItem(<TreeView control> , <Node path> , <Procedure name> [, <Custom parameter> [, <Duplicate identifier>]])

<Result>: Integer

Number of listed elements.

<TreeView control>: Control name

Name of TreeView control to use.

<Node path>: Character string

Full path of node from which the elements will be listed. 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).
corresponds to the NULL constant to list from the root of TreeView control.

<Procedure name>: Character string

Name of WLanguage procedure that will be called whenever a "child" element is found.

<Custom parameter>: Optional integer

Parameter passed to the procedure <Procedure name>.

<Duplicate identifier>: Optional boolean

Indicates the management mode of duplicates in the elements:
False (default value): no management is performed.
True: the names of path elements are built in order to contain their identifier.

Remarks

WLanguage procedure

The <Procedure name> procedure is called whenever a "child" element is found. This procedure is a WLanguage procedure.

This procedure must be declared as follows:

PROCEDURE <Procedure name> (<TreeView control>, <Child path>,..
<Element>, <Level>, <Optional parameter>)

The different parameters are as follows:

<TreeView control> (character string with quotes):
Name of TreeView control to use.
<Child path> (character string):
Full path of the "child" found (without the name) or an empty string ("") if it is the root of TreeView control. This parameter always ends with the "TAB" separator. This parameter will be initialized and filled whenever the procedure is called.
Note: if the <Duplicate identifier> parameter is set to True, the names of elements will contain the associated identifier if it exists. See Managing duplicates in the treeviews for more details.
<Element> (character string):
Name of the element found. This parameter will be initialized and filled whenever the procedure is called.
<Level> (integer):
Level of element found in relation to the initial search element:
1. Direct child
2. Grand child
3. ...
<Optional parameter> (integer):
Value passed in <Custom parameter> of TreeListItem. If <Custom parameter> is not specified, <Custom parameter> corresponds to the NULL constant.

Versions 20 and later
Note: This procedure can be an internal procedure.

New in version 20
Note: This procedure can be an internal procedure.

Note: This procedure can be an internal procedure.

Interrupting TreeListItem

TreeListItem cannot be interrupted as long as all "child" elements have not been browsed.

To force the interruption of the browse performed by TreeListItem, use the following code line in <Procedure name>:

RESULT False

In this case, TreeListItem returns the number of elements browsed until the call to "RESULT False".

Component : wd240obj.dll