<PDF Reader>.Highlight (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<PDF Reader>.Highlight (Function)

In french: <Lecteur PDF>.Surligne

Finds a text in the document displayed by a PDF Reader control and highlights the occurrences of this text in the control.

Example

// Highlights all "WINDEV" occurrences found in a PDF Reader control in yellow
PDF_READER_PDF.Highlight("WINDEV", LightYellow, WholeWord)
// Highlights all "WEBDEV" occurrences in blue
PDF_READER_PDF.Highlight("WEBDEV", LightBlue, WholeWord)
// Highlights all "WINDEV Mobile" occurrences in orange
PDF_READER_PDF.Highlight("WINDEV Mobile", LightOrange, WholeWord)
// Deletes all highlighting
PDF_READER_PDF.Highlight("")

Syntax

<Result> = <PDF Reader control>.Highlight(<Searched text> [, <Color> [, <Search options>]])

<Result>: Integer

Number of text occurrences found in the control.
0 if no element contains the searched text.

<PDF Reader control>: Control name

Name of PDF Reader control to use.

<Searched text>: Character string

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

<Color>: Integer, constant or optional Color variable

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 WLanguage preset color.
a variable of type Color.
Remark: The color used by default is light yellow.

<Search options>: Optional Integer constant

Indicates the search options:
WholeWord Searches for a whole word (between punctuation characters or spaces).
IgnoreCase Case and accent insensitive search (ignores uppercase/lowercase differences).

No option is selected by default: the search is sensitive to the case and it is performed on incomplete words.

Remarks

As long as this function is not called with an empty string ("") to stop the highlighting, all new calls will add an additional highlighting.

Business / UI classification: UI Code

Component: wd270obj.dll