PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • WLanguage procedure
  • Interrupting TableListChild
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
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
// Lists the "children" of the "Desserts" node in the "TVT_RecipeTV" treeview table
// 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 Name> procedure.

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 Name> procedure.
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.
Note: This procedure can be an internal procedure.

Interrupting TableListChild

TableListChild cannot be interrupted as long as all the "child" elements have not been browsed.
To force the interruption of the browse performed by TableListChild, use the following code line in <Procedure Name>:
RESULT False
In this case, TableListChild returns the number of elements browsed until the call to "Result False".
Components
WINDEVReports and Queries wd230obj.dll
WEBDEV - Server code wd230page.dll
Windows Mobile wp230obj.dll
Linux wd230obj.so
Minimum required version
  • Version 21
This page is also available for…
Comments
Click [Add] to post a comment