TableListChild (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

WLanguage procedure
Interrupting TableListChild

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

TableListChild (Function)

In french: TableListeFils

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

Example

// List the "children" of "Desserts" node in the "TVT_RecipeTV" TreeView Table control
// The "ExpandAll" procedure is called for each "child" element found in the "Desserts" node
nNbDesserts is int
nNbDesserts = TableListChild(TVT_RecipeTV, "Recipes" + TAB + "Desserts", "ExpandAll")

Syntax

Listing the children of a branch identified by its path Hide the details

<Result> = TableListChild(<TreeView Table control> , <Element name> , <Procedure name> [, <Custom parameter>])

<Result>: Integer

Number of listed elements.

<TreeView Table control>: Control name

Name of TreeView Table control to use.

<Element name>: Character string (with quotes)

Name of element to use. This parameter has the following format:

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

A WLanguage error occurs if this parameter does not correspond to an existing element.

<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>.

Listing the children of a branch identified by its subscript Hide the details

<Result> = TableListChild(<TreeView Table control> , <Row number> , <Procedure name> [, <Custom parameter>])

<Result>: Integer

Number of listed elements.

<TreeView Table control>: Control name

Name of TreeView Table control to use.

<Row number>: Integer

Number of the row corresponding to the branch to use.

<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>.

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 Table control>, <Child branch>,..
<Element>, <Level>, <Optional parameter>)

The different parameters are as follows:

<TreeView Table control> (character string with quotes):
Name of TreeView Table control to use.
<Child branch> (character string):
Full path of "child" found (without the name) or an empty string ("") if it is the root of TreeView Table control. This parameter always ends with the "TAB" separator. This parameter will be initialized and filled whenever the procedure is called.
<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 TableListChild. If <Custom parameter> is not specified, <Custom parameter> corresponds to the NULL constant.

Remark: This procedure can be an internal procedure.

Interrupting TableListChild

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

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

RESULT False

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

Component : wd240obj.dll