TextSearchBegin Method

Initialize for the search process. This should be called before starting the actual search. with method run().

Namespace: pdftron.PDF
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255

Syntax

public bool Begin(
	PDFDoc doc,
	string pattern,
	int mode,
	int start_page,
	int end_page
)

Public Function Begin ( 
	doc As PDFDoc,
	pattern As String,
	mode As Integer,
	start_page As Integer,
	end_page As Integer
) As Boolean

public:
virtual bool Begin(
	[InAttribute] PDFDoc^ doc, 
	[InAttribute] String^ pattern, 
	[InAttribute] int mode, 
	[InAttribute] int start_page, 
	[InAttribute] int end_page
) sealed

function Begin(doc, pattern, mode, start_page, end_page);

Parameters

doc: Type: pdftron.PDFPDFDoc
the PDF document to search in.
pattern: Type: SystemString
the pattern to search for. When regular expression is used, it contains the expression, and in verbatim mode, it is the exact string to search for.
mode: Type: SystemInt32
the mode of the search process.
start_page: Type: SystemInt32
the start page of the page range to search in. -1 indicates the range starts from the first page.
end_page: Type: SystemInt32
the end page of the page range to search in. -1 indicates the range ends at the last page.

Return Value

Type: Boolean
true if the initialization has succeeded.

Reference

TextSearch Class

pdftron.PDF Namespace

TextSearchAddLanguageSpecificTextSet("LST60451F94_0?cpp=::|nu=.");Begin Method

Parameters

Return Value

Reference

TextSearchBegin Method