GetText

Returns the text content of the range. Paragraph breaks are represented as "\r".

Syntax

expression.GetText(options);

expression - A variable that represents an ApiTextRange class.

Parameters

Name	Required/Optional	Data type	Default	Description
options	Optional	object		Options for formatting the returned text.
options.Math	Optional	boolean	true	Defines if the resulting string will include mathematical expressions or not.
options.NewLineSeparator	Optional	string	'\r'	Defines how the line separator will be specified in the resulting string. Any symbol can be used. The default separator is "\r".
options.TableCellSeparator	Optional	string	'\t'	Defines how the table cell separator will be specified in the resulting string. Any symbol can be used. The default separator is "\t".
options.TableRowSeparator	Optional	string	'\r\n'	Defines how the table row separator will be specified in the resulting string. Any symbol can be used. The default separator is "\r\n".
options.ParaSeparator	Optional	string	'\r\n'	Defines how the paragraph separator will be specified in the resulting string. Any symbol can be used. The default separator is "\r\n".
options.TabSymbol	Optional	string	'\t'	Defines how the tab will be specified in the resulting string (does not apply to numbering). Any symbol can be used. The default symbol is "\t".

Returns

string

Example

Read the text covered by a text range in a shape on a worksheet.

// The range of a whole text body returns every character it holds.

// Read the text of the range.

let worksheet = Api.GetActiveSheet();
let fill = Api.CreateSolidFill(Api.RGB(255, 111, 61));
let stroke = Api.CreateStroke(0, Api.CreateNoFill());
let shape = worksheet.AddShape("rect", 200 * 36000, 80 * 36000, fill, stroke, 3, 0, 1, 0);

let docContent = shape.GetContent();
let paragraph = docContent.GetElement(0);
paragraph.AddText("Hello World");

let range = shape.GetTextRange();

let text = range.GetText();

worksheet.GetRange("A1").SetValue("GetText: " + text);