ListSelect (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Controls, pages and windows / List Box functions

Equivalence
Value of the selected element
Miscellaneous

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ListSelect (Function)

In french: ListeSelect

Returns the index of the selected element in a List Box, ListView or Combo Box control.

Reminder: The selected element corresponds to the current element onto which the selection bar is displayed.

Remark: ListSelect can be used on:

List Box controls based on a data file or populated programmatically,
single-selection or multi-selection List Box controls.

In this version, ListSelect cannot be used on multi-selection List Box controls.

Example

See additional examples

// Index of the selected element in "LIST_CustomerList"
ResElementIndex = ListSelect(LIST_CustomerList)

// Rows selected in a multi-selection List Box control
i is int = 1
SelectedRowIndex is int
SelectedRowIndex = ListSelect(LIST_List1, 1)
WHILE SelectedRowIndex <> -1
Trace("Row #" + SelectedRowIndex + " is selected")
i++
SelectedRowIndex = ListSelect(LIST_List1, i)
END

// Equivalent to:
// FOR EACH SELECTED ROW OF LIST_List1
// Trace("Row #" + LIST_List1 + " is selected")
// END

Syntax

<Result> = ListSelect(<List Box control> [, <Rank>])

<Result>: Integer

Index of the selected element in the specified List Box (or Combo Box) control,
-1 if no element is selected.
For a multi-selection List Box control, the rank of the selected element must be specified <Rank>).

<List Box control>: Control name

Name of List Box (or Combo Box) control to use. If this parameter corresponds to an empty string (""), the index of the element selected in the List Box control (or Combo Box) to which the current event belongs is returned.
The name of the List Box (or Combo Box) control to use must be specified.

<Rank>: Optional integer

Rank of selection for a multi-selection List Box control. If this parameter is not specified, the index of the first selected element is returned.
For example: To retrieve the first selected element, the rank will be 1, to retrieve the second selected element, the rank will be 2, etc.

Remarks

Equivalence

The following syntaxes are equivalent:

Index is int
Index = <List Box control>

and

Index = ListSelect(<List Box control>)

Value of the selected element

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

Index is int
Index = ListSelect(<List Box control>)
<Element value> = <List Box control>[Index]

and

<Element value> = <List Box control>[<List Box control>]

Miscellaneous

To get the index of the element selected in a Table control, use TableSelect.
ListSelect can be used on a "Combo Box" table column.

Component: wd300obj.dll