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

ListItem

Presentation

Example

Interrupting <TreeView>.ListItem

See also

<TreeView>.ListItem (Function)

In french: <Arbre>.ListeFils

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

// List the "children" of the "Desserts" node in the "TREE_TVRecipe" TreeView
// The "ExpandAll" procedure is called
// for each "child" element found in the "Desserts" node
Res = TREE_TVRecipe.ListItem("Recipes" + TAB+ "Desserts", "ExpandAll")

Syntax

<Result> = <TreeView control>.ListItem(<Node path> , <WLanguage procedure> [, <Custom parameter> [, <Duplicate identifier>]])

<Result>: Integer

Number of listed elements.

<TreeView control>: Control name

Name of the TreeView control to be used.

<Node path>: Character string

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

<WLanguage procedure>: Procedure name

Name of WLanguage procedure that will be called whenever a "child" element is found.
For more details on this procedure, see Parameters of the procedure used by <TreeView>.ListItem.

<Custom parameter>: Optional integer

Parameter passed to <WLanguage procedure>.

<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

Interrupting <TreeView>.ListItem

<TreeView>.ListItem cannot be interrupted as long as all "child" elements have not been browsed.

To force the interruption of the browse performed by <TreeView>.ListItem, use the following line of code in <WLanguage procedure>:

RESULT False

In this case, <TreeView>.ListItem returns the number of elements browsed until the call to "RESULT False".

Component: wd280obj.dll