pdftron::PDF::SearchResult Class Reference

#include <TextSearch.h>

Public Member Functions
	operator bool ()
bool	IsFound () const
bool	IsDocEnd () const
bool	IsPageEnd () const
int	GetPageNumber () const
UString	GetMatch () const
UString	GetAmbientString () const
Highlights	GetHighlights () const

Detailed Description

The result of running pdftron::PDF::TextSearch::Run()

Definition at line 19 of file TextSearch.h.

Member Function Documentation

UString pdftron::PDF::SearchResult::GetAmbientString

(

)

const

Returns

the ambient string of the found string (computed only if 'e_ambient_string' is set).

Highlights pdftron::PDF::SearchResult::GetHighlights

(

)

const

Returns

The Highlights info associated with the match (computed only if 'e_highlight' is set).

UString pdftron::PDF::SearchResult::GetMatch

(

)

const

Returns

the string that matches the search pattern.

int pdftron::PDF::SearchResult::GetPageNumber

(

)

const

Returns

the number of the page with the match.

bool pdftron::PDF::SearchResult::IsDocEnd

(

)

const

Returns

true if finished searching the entire document.

bool pdftron::PDF::SearchResult::IsFound

(

)

const

Returns

true if a match was found.

bool pdftron::PDF::SearchResult::IsPageEnd

(

)

const

Returns

true if finished searching a page.

pdftron::PDF::SearchResult::operator bool ( )

inline

Returns

true if a match was found.

Definition at line 26 of file TextSearch.h.

---

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

• PDF/TextSearch.h