RichText.GetText

OverviewExamples

string RichText.GetText (

string ObjectName,

boolean RawRTF = true )

Description

Returns the text displayed in a richtext object.

Parameters

ObjectName

(string) The name of the richtext object.

RawRTF

(boolean) Whether to return the raw RTF text (including formatting codes) or the text as displayed in the richtext object (unformatted).

VALUE	DESCRIPTION
true	Return the raw RTF text (including formatting codes). (Default)
false	Return the text as displayed in the object. (unformatted).

Returns

(string) The text that is currently displayed in the richtext object. If an error occurs, a blank string "" will be 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.