FoxitPDFSDKforWeb  7.1.1
Foxit PDF SDK for Web
TextSearchMatch Class Reference

The match result of text search. More...

Public Member Functions

 getEndCharIndex ()
 Get the index of the last character of current match pattern, based on current match page. More...
 
 getPageIndex ()
 Get the page index, to which current match belongs. More...
 
 getRects ()
 Get the rectangles of current match pattern. More...
 
 getSentence ()
 Get the sentence that contains current match pattern. More...
 
 getSentenceStartIndex ()
 Get the index of the first character of current match pattern, based on the match sentence. More...
 
 getStartCharIndex ()
 Get the index of the first character of current match pattern, based on current match page. More...
 

Detailed Description

The match result of text search.

Member Function Documentation

◆ getEndCharIndex()

TextSearchMatch::getEndCharIndex ( )
inline

Get the index of the last character of current match pattern, based on current match page.

Returns
{number}

◆ getPageIndex()

TextSearchMatch::getPageIndex ( )
inline

Get the page index, to which current match belongs.

Returns
{number}

◆ getRects()

TextSearchMatch::getRects ( )
inline

Get the rectangles of current match pattern.

Returns
{rectArray} - [{left, right, bottom, top}]

◆ getSentence()

TextSearchMatch::getSentence ( )
inline

Get the sentence that contains current match pattern.

Returns
{string}

◆ getSentenceStartIndex()

TextSearchMatch::getSentenceStartIndex ( )
inline

Get the index of the first character of current match pattern, based on the match sentence.

Returns
{number}

◆ getStartCharIndex()

TextSearchMatch::getStartCharIndex ( )
inline

Get the index of the first character of current match pattern, based on current match page.

Returns
{number}

Foxit Software Corporation Logo
@2019 Foxit Software Incorporated. All rights reserved.