<Table>.Expand (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

Expand

Presentation

Example

Use conditions

Branch to expand

Selection bar

Runtime speed for the TreeView Table controls

See also

<Table>.Expand (Function)

In french: <Table>.Déroule

Expands:

a branch that was previously collapsed in a TreeView Table control. The "child" nodes are visible in the control.
a break that was previously collapsed in a Table control. The break elements are visible in the control.

Reminder: At runtime, a node is expanded when the node name is preceded by "-".

Example

// Expands the selected branch in the TreeView Table control
TVT_ScheduleTable.Expand()

// Expands the entire TreeView Table control
TVT_ScheduleTable.Expand(1)
// Equivalent to: TVT_ScheduleTable.ExpandAll()

// Expands the specified branch in the TreeView Table control
TVT_ScheduleTable.Expand("MyRoot" + TAB + "MyBranch")

Syntax

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

<TreeView Table control>.Expands([<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 expand. The branch found in the current row is expanded if this parameter is not specified.

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

<TreeView Table control>.Expands([<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 expand. This parameter has the following format:

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

A WLanguage error occurs if this parameter does not correspond to an existing branch.
The branch found in the current row is expanded if this parameter is not specified.

Table control with breaks: Expanding a break Hide the details

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

<Table control>: Control name

Name of the Table control to be used.

<Row number>: Optional integer

Number of the row whose break will be expanded. This number must correspond either to the number of the current row, or to the number of the first row of the break to expand. If this parameter is not specified, the break of current row is collapsed.

<Name of break>: Optional character string

Name of the break to be expanded. This parameter must be specified in case of nested breaks. It is used to define the break that will be expanded. By default, no break is expanded if the breaks are nested.

Remarks

Use conditions

<Table>.Expand can be used on:

a TreeView Table control.
a Table control populated programmatically.
a Table control with in-memory data source.
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 expand

<Table>.Expand 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 if the break to expand is not specified. if no row is selected in the Table control and if <Row number> is not specified.

Remarks 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 expanded (equivalent to <Table>.ExpandAll).
When <Table>.Expand is called, if the specified branch has a procedure associated via the AddChildDelayed property, this procedure will be executed.

Selection bar

<Table>.Expand does not change the position of the selection bar.

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