Home | Sign in | English EN
  • Node to collapse
  • Selection bar
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Stored procedures
Collapses a branch that was expanded beforehand (as well as its child elements):
  • The "child" nodes are no longer visible in the TreeView control.
  • The child nodes are collapsed.
Example of TreeView control:
Vocabulary linked to a TreeView control
Reminder: At runtime, a node is collapsed when the node name is preceded by "+".
// Collapse the "Desserts" node in the "TREE_TVRecipe" TreeView control
Res = TREE_TVRecipe.CollapseAll("Recipes" + TAB + "Desserts")
<Result> = <TreeView control>.CollapseAll([<Node to collapse>])
<Result>: Boolean
  • True if the node and its children have been collapsed,
  • False otherwise.
<TreeView control>: Control name
Name of TreeView control to use.
<Node to collapse>: Optional character string
Path of node to collapse. This parameter has the following format:
"<Name of root>" + TAB + ["<Name of 1st node>" + TAB + ...
["<Name of 2nd node>" + TAB + [...]]]"<Leaf name>"
If this parameter is not specified, the TreeView control is collapsed from the root.
In case of duplicates on a path element, this path can contain the element identifier (specified at the end of its name by TreeID).

Node to collapse

If the node to collapse:
  • is not found, <TreeView>.CollapseAll returns False.
  • is not specified, <TreeView>.CollapseAll returns True. The TreeView control is collapsed from its root.
  • is a leaf, <TreeView>.CollapseAll returns True.
  • is already collapsed, <TreeView>.CollapseAll returns True.

Selection bar

  • If the selection bar was positioned on one of the elements of the node to collapse, the bar is positioned on the collapsed node after the call to <TreeView>.CollapseAll.
  • The modification code is called whenever the selection bar is moved. If two levels are collapsed and if the selection bar is positioned on the higher node, the modification codes of each level are run.
  • The full path of the selected element is returned by <Tree>.Select.
Component: wd270obj.dll
Minimum version required
  • Version 23
This page is also available for…
Click [Add] to post a comment