<Table>.Select (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Table functions

Prefix syntax

Select

Presentation

Example

Use conditions

Equivalence <Table>.Select

Value of the selected element

See also

<Table>.Select (Function)

In french: <Table>.Select

Returns the index of the selected element in the Table or TreeView Table control. This index can correspond to:

the number of the selected row. The selected row corresponds to the current row on which the selection bar is displayed.
the number of the selected column if the control allows the selection mode by column. This option can be configured in the "UI" tab of the control description.
the number of the selected cell if the controls allows the selection mode by cell. This option can be configured in the "UI" tab of the control description.
the column number of the selected cell if the controls allows the selection mode by cell. This option can be configured in the "UI" tab of the control description.

Example

// Index of the selected row in the "TABLE_Product" control
ResSelect = TABLE_Product.Select()

// Rows selected in a multi-selection Table control populated programmatically
FOR i = 1 _TO_ TABLE_TABLE1.SelectOccurrence()
Trace("Selected element: " + TABLE_TABLE1.Select(i))
END

// Equivalent to:
// i is int
// FOR EACH SELECTED ROW i OF TABLE_TABLE1
// Trace("Selected element: " + TABLE_TABLE1.Select(i-1))
// END

// Delete all selected rows from a Table control
// <Table>.DeleteSelect can also be used
i is int
NbSelection is int
NbSelection = TABLE_MyTable.SelectCount()
FOR i = NbSelection TO 1 STEP -1
TABLE_MyTable.Delete(TABLE_MyTable.Select(i))
END

Syntax

<Result> = <Table control>.Select([<Rank> [, <Information to return>]])

<Result>: Integer

Index of the selected element in the specified Table control,
-1 if no element is selected.

<Table control>: Control name

Name of the control to be used. This control can correspond to:
a Table control.
a TreeView Table control.

<Rank>: Optional integer

Rank of selection for a multi-selection control. If this parameter is not specified, the index of the first selected row is returned.
For example, to retrieve the first selected element, <Rank> = 1.
To retrieve the second selected element, <Rank> = 2, etc.

<Information to return>: Optional Integer constant

Type of information to return:
tsCellColumn <Result> will correspond to the column number for the selected cell.
tsCellRow <Result> will correspond to the row number for the selected cell.
New in version 28
This constant corresponds to tsCellLine in previous versions.
tsColumn <Result> will correspond to the number of the selected column.
tsRow
(Default value) <Result> will correspond to the number of the selected row.
If this parameter is not specified, the function will return the number of the selected row.
This parameter is not available. The function will return the number of the selected row.

Remarks

Use conditions

<Table>.Select can be used on:

Table or TreeView Table controls based on a data file.
Table or TreeView Table controls populated programmatically.
single-selection or multi-selection controls. For multi-selection Table controls, you must use <Table>.Select in a loop to get all the selected rows.

Equivalence <Table>.Select

The following syntaxes are equivalent:

Index is int
Index = <Table control>

Index = <Table control>.Select()

Value of the selected element

To retrieve the value of the selected element, the syntax is:

Index is int
Index = <Table control>.Select()
<Element value> = <Table control> [Index]

<Element value> = <Table control> [<Table control>]

Component: wd280obj.dll