ListSelect (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Equivalence
Value of selected element
Miscellaneous

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ListSelect (Function)

In french: ListeSelect

Returns the subscript of the selected element in a List Box (or ListView) control or in a 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:

the browsing or memory List Box controls,
single-selection or multiselection Looper controls.

In this version, ListSelect cannot be used on multiselection List Box controls.

Versions 16 and later

This function is now available for WINDEV applications in Linux.

New in version 16

This function is now available for WINDEV applications in Linux.

Example

See additional examples

// Subscript of selected element in "LIST_CustomerList"
ResElementSubscript = ListSelect(LIST_CustomerList)

// Rows selected in a multiselection List Box control
i is int = 1
SelectedRowSubscript is int
SelectedRowSubscript = ListSelect(LIST_List1, 1)
WHILE SelectedRowSubscript <> -1
Trace("Row #" + SelectedRowSubscript + " is selected")
i++
SelectedRowSubscript = 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

Subscript of the element selected in the specified List Box (or Combo Box) control,
-1 if no element is selected.
For a multiselection 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 subscript 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 multiselection List Box control. If this parameter is not specified, the subscript of 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:

Subscript is int
Subscript = <List Box control>

and

Subscript = ListSelect(<List Box control>)

Value of selected element

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

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

and

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

Miscellaneous

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

Component : wd260obj.dll