FindText Method (text, matchCase, matchWholeWord)

previous page next page

Pageflex Document Action API FindText Method (text, matchCase, matchWholeWord)

Finds all instances of the specified text in the document.

Syntax

Visual Basic

Managed C++

public Range[] FindText (
	string text,
	bool matchCase,
	bool matchWholeWord
)

Public Function FindText ( _
	text As String, _
	matchCase As Boolean, _
	matchWholeWord As Boolean _
) As Range()

public:
array<Range^>^ FindText (
	String^ text, 
	bool matchCase, 
	bool matchWholeWord
)

Parameters

text (String): Text to search for.
matchCase (Boolean): trueTruetrue for a case-sensitive search; falseFalsefalse for a case-insensitive search.
matchWholeWord (Boolean): trueTruetrue if only complete words should be matched; falseFalsefalse otherwise.

Return Value

Returns an array of Range objects representing all instances of text in the document.

Remarks

If modifying the returned Range objects, iterate in reverse order.

Exceptions

Exception	Condition
ArgumentNullException	The value supplied for text was nullNothingnullptr.
StaleScriptingObjectException	This object's associated internal object no longer exists.

Assembly: PFScript Version: 8.0.7.1407 (Module: PFScript)

previous page start next page