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.

Name of Table control to use. 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.

Number of the row whose details must be collapsed. If this parameter is not specified, the details of the current row are collapsed.

Remarks

Use conditions

TableEnroule_objet can be used in:

a TreeView Table control.

a memory Table control.

a browsing Table control loaded in memory.

an Ajax Table control or a classic Table control.

a Table control in browser mode.

This function cannot be used on the browsing Table controls (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, the bar 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.