FoxitPDFSDKforWeb  7.1.1
Foxit PDF SDK for Web
DocTextSearch Class Reference

This class can construct text search in a PDF document. More...

Public Member Functions

 destroy ()
 destroy DocTextSearch
 
 findNext ()
 Search for next matched pattern. More...
 
 findPrev ()
 Search for previous matched pattern. More...
 
 getId ()
 Gets the id of the DocTextSearch. More...
 
 setCurrentPageIndex (index)
 Sets the page index for the current query. More...
 
 setEndPageIndex (index)
 Set the end page index. More...
 
 setStartPageIndex (index)
 Set the starting page index. More...
 

Detailed Description

This class can construct text search in a PDF document.

Member Function Documentation

◆ findNext()

DocTextSearch::findNext ( )
inline

Search for next matched pattern.

Returns
{Promise.<TextSearchMatch | null>} - null is returned if it is not found. TextSearchMatch

◆ findPrev()

DocTextSearch::findPrev ( )
inline

Search for previous matched pattern.

Returns
{Promise.<TextSearchMatch | null>} - null is returned if it is not found

◆ getId()

DocTextSearch::getId ( )
inline

Gets the id of the DocTextSearch.

Returns
{String}

◆ setCurrentPageIndex()

DocTextSearch::setCurrentPageIndex (   index)
inline

Sets the page index for the current query.

Parameters
index{number}

◆ setEndPageIndex()

DocTextSearch::setEndPageIndex (   index)
inline

Set the end page index.

Parameters
index{number}

◆ setStartPageIndex()

DocTextSearch::setStartPageIndex (   index)
inline

Set the starting page index.

Parameters
index{number}

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