TdxPDFViewerOptionsFindPanel.HighlightSearchResults Property

Specifies if all the text search results are highlighted in the displayed PDF document.

Declaration

property HighlightSearchResults: Boolean read; write;

Property Value

Type
Boolean

Remarks

Use this property to switch between the two text search modes available in the PDF Viewer control:

Value	Description
True	A text search routine processes the entire document at once, builds a list of found matches, and highlights the corresponding text ranges with a LookAndFeel-dependent color. Subsequent search method calls with the same search string and settings (or navigation between the found matches within the document via the Find panel) do not raise the OnSearchProgress event.
False	A search routine finds only the nearest matching text result within the document. Subsequent identical search method calls or navigation between the text matches within the document via the Find panel raise the OnSearchProgress event if the next matching text range is located on the next or previous page (depending on the search direction). In this search mode, no text ranges within the document are highlighted.

Note

The HighlightSearchResults property value has no effect on calling the PDF Viewer’s TextSearch.Find and Document.FindText procedures that return all matching text ranges within the loaded document as the AFoundRanges parameter. These procedures always process the entire document at once.