SearchHighlightOptions class

SearchHighlightOptions class

Provides options for searching and highlighting text in documents loaded into the Viewer class.

The SearchHighlightOptions type exposes the following members:

Constructors

Constructor Description
init

Properties

Property Description
background_color The background color for highlighting.
foreground_color The foreground (text) color for highlighting.
is_search_term_reg_ex The property indicating whether the search term should be treated as a regular expression or as a text literal. Default is False — treat as a text literal.
search_term The text (or regex pattern, if SearchHighlightOptions.is_search_term_reg_ex property is True) to search for.

See Also