<List Box>.Seek (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Type of search
parameter
Uppercase/Lowercase characters
Seeking and selecting an element in a List Box or Combo Box control
Seeking an element in a browsing List Box or Combo Box control: search on the stored value or on the displayed value
Search and selection in a List Box control
Miscellaneous

WINDEV

WEBDEV

WINDEV Mobile

Others

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 gLink).

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

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

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

Reminder: The browing List Box controls are not available in this version.

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

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.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

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

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

Syntax

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

<Result>: Integer

Subscript of 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 browsing List Box control, 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.

<Sought element>: Character string (with quotes)

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

Subscript 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 the memory List Boxes.
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 <Sought 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 <Sought 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:

Subscript is int
Cnt is int = 0
// Position on the first corresponding element
Subscript = LIST_CustomerList.Seek("SMI", False)
WHILE Subscript <> -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 memory List Box control, the search ignores the uppercase and lowercase characters.
If the control is a browsing List Box control, 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.

The browsing List controls 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 browsing List Box or Combo Box control, 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 browsing List Box or Combo Box control: search on the stored value or on the displayed value

Case 1: The List Box or Combo Box control is filled by a data file ("Direct access" option):
The search is performed according to the value of gLinkActivate:

If gLinkActivate(Control, True) (by default): <List Box>.Seek performs the search on the "search item" declared in the "Content" tab of control description.
If gLinkActivate(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 filled by 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 fill 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 fill the List Box control are:

Browsed file,
Displayed item,
Search item.

Miscellaneous

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

Component: wd260obj.dll