SearchFirstOnPage

 Top  Previous  Next

[This method is new in  version 2.04 of Gnostice PDFtoolkit ActiveX/. NET ProPlus Edition]

 

This function searches for  the first instance of the given text on the specified page. If no match is found, the return value is 0. If a match is found, the return value is the index of the beginning of the searched text in the text property of the gtPDFTextElementX class object which is passed as a parameter.

 

Syntax

 

[VC++]

long SearchFirstOnPage(LPCTSTR SearchText, LPDISPATCH* TextElement, BOOL

CaseSensitive, BOOL WholeWord, long PageNo);

 

[CS]

public abstract new Int32 SearchFirstOnPage ( String SearchText , gtPDFTextElementX TextElement , Boolean CaseSensitive , Boolean WholeWord , Int32 PageNo );

 

[VB]

Function SearchFirstOnPage(SearchText As String, TextElement As gtPDFTextElementX, CaseSensitive As Boolean, WholeWord As Boolean, PageNo As Long) As Long

 

 

Parameters

       

       SearchText

            Specifies the string to be searched.

       

       TextElement

           Specifies the gtPDFTextElementX class object, which contains the searched text element.

       

       CaseSensitive

           If set, the search is case sensitive.

 

       WholeWord

            If set, searches for the whole word.

 

       PageNo

            Specifies the page number in which the search is performed.