DocSeek (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

DocSeek (Function)

In french: DocRecherche

Finds a character string:

in an entire Word Processing document.
Versions 24 and later
in a fragment.
New in version 24
in a fragment.
in a fragment.

Caution: This documentation presents the last features of the Word Processing control. Make sure that all the necessary modules are updated.

Example

arrFragments is array of docFragment = DocSeek(WP_MyDocument, "%CustomerName%")
// Replace all "%CustomerName%" by the customer name
FOR EACH f OF arrFragments
f.Text = Customer.Name
END

// Seeks "BEAUTIFUL" in the text
// Selects the first one found to change its color
arrFragments is array of docFragment = DocSeek(WP_NoName1, "BEAUTIFUL")

IF arrFragments.Count >= 1 THEN
// Position the cursor at the beginning of the first word found
WP_NoName1.Cursor = arrFragments[1].StartPosition
// Calculate the selection length
WP_NoName1.SelectionLength = ...
arrFragments[1].EndPosition - arrFragments[1].StartPosition+1
// Modify the text color
arrFragments[1].Formatting.TextColor = PastelRed
BREAK
END

Syntax

<Result> = DocSeek(<Search scope> , <Text to find> [, <Options>])

<Result>: Array of docFragment variables

Array of docFragment variables corresponding to all the document fragments where the searched text was found.

<Search scope>: Document variable, docFragment variable or control name

Element where the search will be performed. This element can correspond to:
the name of a Word Processing control.
a variable of type Document.
Versions 24 and later
a variable of type docFragment.
New in version 24
a variable of type docFragment.
a variable of type docFragment.

<Text to find>: Character string

Text that must be found in the specified element.

<Options>: Optional constant (or combination of constants)

Search options:
IgnoreCase Case and accent insensitive search (ignores uppercase and lowercase differences).
WholeWord Search for the whole word (enclosed in punctuation characters or in space characters).

By default, the search is case-sensitive: the searched text and the text to find must have the same case. To perform a case-insensitive search, use the IgnoreCase constant.

Business / UI classification: UI Code

Component: wd270mdl.dll