TextSearchRun Method

Search the document and returns upon the following circumstances:

Reached the end of the document
Reached the end of a page (if set to return by specifying mode 'e_page_stop')
Found an instance matching the search pattern

Remarks

Note that this method should be called in a loop in ordre to find all matching instances; in other words, the search is conducted in an incremental fashion.

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

Syntax

C++

JavaScript

Copy

public TextSearchResultCode Run(
	Int32Ref page_num,
	StringRef result_str,
	StringRef ambient_str,
	Highlights hlts
)

Public Function Run ( 
	page_num As Int32Ref,
	result_str As StringRef,
	ambient_str As StringRef,
	hlts As Highlights
) As TextSearchResultCode

public:
virtual TextSearchResultCode Run(
	[InAttribute] Int32Ref^ page_num, 
	[InAttribute] StringRef^ result_str, 
	[InAttribute] StringRef^ ambient_str, 
	[InAttribute] Highlights^ hlts
) sealed

function Run(page_num, result_str, ambient_str, hlts);

Parameters

page_num: Type: pdftron.CommonInt32Ref
the number of the page the found instance is on.
result_str: Type: pdftron.CommonStringRef
the found string that matches the search pattern.
ambient_str: Type: pdftron.CommonStringRef
the ambient string of the found string (computed if 'e_ambient_string' is set).
hlts: Type: pdftron.PDFHighlights
the Highlights info associated with the found string (computed if 'e_highlight' is set).

Return Value

Type: TextSearchResultCode
the code indicating the reason of the return. Note that only when the returned code is 'e_found', the resulting information is meaningful.

Reference

TextSearch Class

pdftron.PDF Namespace

TextSearchAddLanguageSpecificTextSet("LSTC2470F49_0?cpp=::|nu=.");Run Method

Parameters

Return Value

Reference

TextSearchRun Method