<List Box>.Seek (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

List functions

Prefix syntax

Seek

Presentation

Example

See also

<List Box>.Seek (Function)

In french: <Liste>.Cherche

Seeks an element in a List Box control (standard list box or listview) or in a Combo Box control (including the values described by gStoredValue).

In this version, the values described by gStoredValue cannot be sought.

Remark: <List Box>.Seek can be used on:

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

Reminder: List Box controls populated programmatically are not available in this version.

Example

// Find the element "Moore" in the List Box control "LIST_CustomerList"
ResSeek = LIST_CustomerList.Seek("Moore")

// Find "Moore" in the "LIST_CustomerList" List Box control based on a data file
// Exact-match search from element 5
ResSeek = LIST_CustomerList.Seek("Moore", True, 5)

Syntax

<Result> = <List Box control>.Seek(<Search element> [, <Type of search> [, <Start of search>]])

<Result>: Integer

Index of the element found.
-1 if no element corresponds to the search.
The element found is not selected. To select the element found, use <List Box>.SelectPlus.
In a List Box control based on a data file, the element found is displayed if it is not visible.

<List Box control>: Control name

Name of List Box (or Combo Box) control to use.

<Search element>: Character string

Element to find in the specified List Box (or Combo Box) control.

<Type of search>: Optional boolean

True (default value) for an exact-match search,
False for a generic search.
This parameter is not available. An exact-match search is performed by default.

<Start of search>: Optional integer

Index from which the search will start in the List Box or Combo Box control.
If this parameter is not specified, the search is performed in the entire control. This parameter is ignored for controls handled programmatically.
This parameter is not available. The search is performed in the entire control by default.

Remarks

Type of search

Exact-match search:
The elements whose value is strictly equal to <Search element> are returned by <List Box>.Seek. For example:

// Return all the customers named "Doe" found in "LIST_Name"
LIST_Name.Seek("Doe")
Generic search:
The elements starting with <Search element> are returned by <List Box>.Seek. For example:

// Return all customers whose name starts with "SMI"
LIST_Name.Seek("SMI", False)

<Start of search> parameter

The <Start of search> parameter is used to find all the occurrences of a string in a List Box or Combo Box control.

For example, to count the number of names starting with "SMI" in the "LIST_CustomerList" control:

Index is int
Cnt is int = 0
// Position on the first corresponding element
Subscript = LIST_CustomerList.Seek("SMI", False)
WHILE Index <> -1
Cnt++
// Find the next name starting with "SMI"
Subscript = LIST_CustomerList.Seek("SMI", False, Subscript + 1)
END

Uppercase/Lowercase characters

If the control is a List Box control populated programmatically, the search ignores the uppercase and lowercase characters.
If the control is a List Box control based on a data file, the search performed on the "Key" items takes into account the search options defined in the data model editor ("General" tab of the item description).

The search is case sensitive.

List Box controls based on a data file are not available.

Seeking and selecting an element in a List Box or Combo Box control

To seek and/or select an element in a List Box or Combo Box control based on a data file, you can use the following syntax:

LIST_OrderList.StoredItem = "CustomerID"
// Find and select the element whose CustomerID is "135"
LIST_OrderList = 135
// If the element sought is not found, LIST_OrderList will be set to -1

The sought element is selected.

Seeking an element in a List Box or Combo Box control based on a data file: search on the stored value or on the displayed value

Case 1: The List Box or Combo Box control is populated with the data from a data file ("Direct access" option):
The search is performed according to the value of gStoredValueEnable:

If gStoredValueEnable(Control, True) (by default): <List Box>.Seek performs the search on the "search item" declared in the "Content" tab of control description.
If gStoredValueEnable(Control, False): <List Box>.Seek performs the search on the "displayed item" declared in the "Content" tab of control description.

Case 2: The List Box or Combo Box control is populated with the data from a data file ("Loaded in memory" option):
<List Box>.Seek performs the search on the "displayed item" declared in the "Content" tab of control description.

Search and selection in a List Box control

If the options used to populate the List Box control are defined in the description window of the control ("Content" tab), the following syntax can be used to seek and select an element in a List Box control:

ListBoxName = SoughtElement

The options used to populate the List Box control are:

Browsed file,
Displayed item,
Search item.

Description of List Box control based on a data file

Miscellaneous

To perform a search in a Table control or in a Combo Box control with table, use TableSearch.
<List Box>.Seek can be used on a "Combo Box" table column.

Component: wd280obj.dll