RichText.FindText

OverviewExamples

table RichText.FindText (

string ObjectName,

string SearchFor,

number Start = 1,

number End = -1,

boolean CaseSensitive = false,

boolean WholeWord = false )

Description

Searches for text in a RichText object.

Parameters

ObjectName

(string) The name of the richtext object.

SearchFor

(string) The text to search for.

Start

(number) The position in the richtext object where the search will begin. The default is 1, which is the first character in object. If you would like to search from the back, specify -1. If the start position is less than the end position, it searches forward. If the start position is greater than the end position, it searches backward.

End

(number) The position in the richtext object where the search will end. The default is -1, which is the last character in object, or if you are searching backward, -1 means the first character in the object. If the start position is less than the end position, it searches forward. If the start position is greater than the end position, it searches backward.

CaseSensitive

(boolean) Whether the search will be case sensitive:

VALUE	DESCRIPTION
true	Make the search case sensitive.
false	Don't make the search case insensitive. (Default)

WholeWord

(boolean) Whether the search will find matching whole words only:

VALUE	DESCRIPTION
true	Find matching whole words only.
false	Find any occurrence of the text. (Default)

Returns

(table) A table containing the start and end positions of the match indexed by "Start" and "End". If there were no matches or an error occurs, nil is returned. You can use Application.GetLastError to determine whether this action failed, and why.

ResultVariable

When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.