ControlFindTextFirst (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

See also

ControlFindTextFirst (Function)

In french: ChampRechercheTextePremier

Finds and selects the first element corresponding to the sought text in a window or control.

Example

// Whenever EDT_SRCH is modified
// Finds and highlights all occurrences
// Highlights the 1st occurrence in blue and displays it if necessary
IF ControlFindTextFirst(MyWindow..Name, EDT_SRCH, 0, iLightBlue) = 0 THEN
BTN_NEXT..State = Grayed
Info("Text not found")
ELSE
BTN_NEXT..State = Active
END

Syntax

<Result> = ControlFindTextFirst(<Element> , <Sought text> [, <Search options> [, <Highlighting of first element> [, <Highlighting of elements found>]]])

<Result>: Integer

Number of occurrences found in the control or window.
0 if no element contains the sought text.

<Element>: Character string (with or without quotes)

Name of element where the search will be performed. This element can correspond to:
a window name. The search is performed in the caption of controls, the text of buttons, the text of edit controls, the text of table rows, ... The search is performed in all the visible controls that have no invisible parent.
a control name. If this element corresponds to a Ribbon control, the search is performed in all ribbon controls.

<Sought text>: Character string (with quotes)

Text that must be found in the specified element.
"" (empty string) to cancel the search.

<Search options>: Optional Integer constant

Indicates the search options:
WholeWord Search for a whole word (enclosed in punctuation characters or in space characters)
IgnoreCase Search while ignoring the case (uppercase/lowercase characters) or the accented characters
0 Search while taking the case into account (uppercase/lowercase characters) on a text "contained in".
No option is selected by default: the search is sensitive to the case and it is performed on incomplete words.

<Highlighting of first element>: Integer or constant (optional)

Color used to highlight the first element found. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a preset color of WLanguage.
Remark: The color used by default is dark blue.

<Highlighting of elements found>: Integer or constant (optional)

Color used to highlight the occurrences found. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a preset color of WLanguage.
Remark: The color used by default is light yellow.

Remarks

A single search can be performed at a given time in a control or in a window.
The call to ControlFindTextFirst cancels a possible previous call to ControlFindHighlight.
The search is not performed in the following controls:
- HTML control and edit control in HTML format.
- ActiveX control.
- Zone not displayed in the Looper controls, List Box controls, Table controls.
- List, table or popup displayed by the combo boxes.

Component : wd250obj.dll