TableEnroule_objet (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

TreeView Table functions

Prefix syntax

TableEnroule_objet

Presentation

Example

Use conditions

Branch to collapse

Selection bar

Runtime speed for the TreeView Table controls

See also

TableEnroule_objet (Function)

In french: <Table>.Enroule

Collapses:

a branch that was previously expanded in a TreeView Table control. "Child" nodes are no longer visible in the TreeView Table control. Child nodes remain in their previous status (collapsed or expanded).
a break that was previously expanded in a Table control. The break elements are no longer visible in the Table control.

Reminder: At runtime, a node is collapsed when the node name is preceded by "+".

Example

// Collapses the selected branch in the TreeView Table control
TVT_Schedule.Collapse()

// Collapses the "TVT_Schedule" TreeView Table control
TVT_Schedule.Collapse(1)
// Equivalent to: TVT_Schedule.CollapseAll()

// Collapses the specified branch in the TreeView Table control
TVT_Schedule.Collapse("MyRoot" + TAB + "MyBranch")

// Collapses the break of the current row in the "TABLE_Break" Table control
TABLE_Break.Collapse(TABLE_Break)

Syntax

TreeView Table: Collapsing a branch while specifying the row number Hide the details

<TreeView Table control>.Collapse([<Row number>])

<TreeView Table control>: Control name

Name of the TreeView Table control to be used.

<Row number>: Optional integer

Number of the row containing the branch to collapse. The branch found in the current row is collapsed if this parameter is not specified.

TreeView Table: Collapsing a branch, specifying its name Hide the details

<TreeView Table control>.Collapse([<Branch name>])

<TreeView Table control>: Control name

Name of the TreeView Table control to be used.

<Branch name>: Optional character string

Name of branch to collapse. This parameter has the following format:

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

A WLanguage error occurs if this parameter does not correspond to an existing branch.
The branch found in the current row is collapsed if this parameter is not specified.
If two branches correspond to the specified path, only the first one is collapsed.

Table with breaks: Collapsing a break Hide the details

<Table control>.Collapse([<Row number> [, <Name of break>]])

<Table control>: Control name

Name of the Table control to be used. This control must have one or more breaks. Otherwise, this function has no effect.

<Row number>: Optional integer

Number of the break row to collapse. This number must correspond either to the number of the current row or to the number of the first row of break to collapsed. If this parameter is not specified, the break of current row is collapsed.

<Name of break>: Optional character string

Name of break to collapse. This parameter must be specified in case of nested breaks. It allows the break that will be collapsed to be defined. By default, no break is collapsed if the breaks are nested.

Remarks

Use conditions

TableEnroule_objet can be used on:

a Table or TreeView Table with in-memory data source.
a Table or TreeView Table control populated programmatically.
a Table control in "Server" or "Server + AJAX" mode.
a Table control in "Browser" mode.

This function cannot be used on the Table controls based on a data file (direct access).

Branch to collapse

TableEnroule_objet has no effect:


TreeView Table control	Table control with breaks
if the branch to collapse is not found. if the branch to collapse is a leaf. if the branch to collapse is already collapsed.	if the Table control contains no break. if the Table control contains several breaks and the break to collapse is not specified. if no row is selected in the Table control and if <Row number> is not specified.

Note for the TreeView Table controls: If <Row number> or <Branch name> corresponds to the branch in the first row, the entire hierarchy of the TreeView Table control is collapsed (equivalent to <Table>.CollapseAll).

Selection bar

For the TreeView Table controls:

If the selection bar was positioned on one of the elements of the node to collapse, it is positioned on the collapsed node after the call to TableEnroule_objet.
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.

For the Table controls with breaks, the selection bar is not modified. It stays on the current element even if the break is collapsed.

Runtime speed for the TreeView Table controls

The runtime speed of syntax 1 is faster than the runtime speed of syntax 2.

Component: wd280obj.dll