PdfiumViewer
Public Member Functions | Properties | List of all members
PdfiumViewer.PdfSearchManager Class Reference

Helper class for searching through PDF documents. More...

Public Member Functions

 PdfSearchManager (PdfRenderer renderer)
 Creates a new instance of the search manager. More...
 
bool Search (string text)
 Searches for the specified text. More...
 
bool FindNext (bool forward)
 Find the next matched term. More...
 
void Reset ()
 Resets the search manager. More...
 

Properties

PdfRenderer Renderer [get]
 The renderer associated with the search manager. More...
 
bool MatchCase [get, set]
 Gets or sets whether to match case. More...
 
bool MatchWholeWord [get, set]
 Gets or sets whether to match whole words. More...
 
Color MatchColor [get]
 Gets or sets the color of matched search terms. More...
 
Color MatchBorderColor [get]
 Gets or sets the border color of matched search terms. More...
 
float MatchBorderWidth [get]
 Gets or sets the border width of matched search terms. More...
 
Color CurrentMatchColor [get]
 Gets or sets the color of the current match. More...
 
Color CurrentMatchBorderColor [get]
 Gets or sets the border color of the current match. More...
 
float CurrentMatchBorderWidth [get]
 Gets or sets the border width of the current match. More...
 
bool HighlightAllMatches [get, set]
 Gets or sets whether all matches should be highlighted. More...
 

Detailed Description

Helper class for searching through PDF documents.

Constructor & Destructor Documentation

◆ PdfSearchManager()

PdfiumViewer.PdfSearchManager.PdfSearchManager ( PdfRenderer  renderer)

Creates a new instance of the search manager.

Parameters
rendererThe renderer to create the search manager for.

Member Function Documentation

◆ FindNext()

bool PdfiumViewer.PdfSearchManager.FindNext ( bool  forward)

Find the next matched term.

Parameters
forwardWhether or not to search forward.
Returns
False when the first match was found again; otherwise true.

◆ Reset()

void PdfiumViewer.PdfSearchManager.Reset ( )

Resets the search manager.

◆ Search()

bool PdfiumViewer.PdfSearchManager.Search ( string  text)

Searches for the specified text.

Parameters
textThe text to search.
Returns
Whether any matches were found.

Property Documentation

◆ CurrentMatchBorderColor

Color PdfiumViewer.PdfSearchManager.CurrentMatchBorderColor
get

Gets or sets the border color of the current match.

◆ CurrentMatchBorderWidth

float PdfiumViewer.PdfSearchManager.CurrentMatchBorderWidth
get

Gets or sets the border width of the current match.

◆ CurrentMatchColor

Color PdfiumViewer.PdfSearchManager.CurrentMatchColor
get

Gets or sets the color of the current match.

◆ HighlightAllMatches

bool PdfiumViewer.PdfSearchManager.HighlightAllMatches
getset

Gets or sets whether all matches should be highlighted.

◆ MatchBorderColor

Color PdfiumViewer.PdfSearchManager.MatchBorderColor
get

Gets or sets the border color of matched search terms.

◆ MatchBorderWidth

float PdfiumViewer.PdfSearchManager.MatchBorderWidth
get

Gets or sets the border width of matched search terms.

◆ MatchCase

bool PdfiumViewer.PdfSearchManager.MatchCase
getset

Gets or sets whether to match case.

◆ MatchColor

Color PdfiumViewer.PdfSearchManager.MatchColor
get

Gets or sets the color of matched search terms.

◆ MatchWholeWord

bool PdfiumViewer.PdfSearchManager.MatchWholeWord
getset

Gets or sets whether to match whole words.

◆ Renderer

PdfRenderer PdfiumViewer.PdfSearchManager.Renderer
get

The renderer associated with the search manager.


The documentation for this class was generated from the following file: