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

Get the text content of a range and display it in a second shape.

// Useful for reading the text covered by a range without modifying it.

// Retrieve the text content of the range and show it on the slide.

const presentation = Api.GetPresentation();
const slide = presentation.GetSlideByIndex(0);
slide.RemoveAllObjects();

const fill = Api.CreateSolidFill(Api.RGB(255, 111, 61));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape("rect", 300 * 36000, 130 * 36000, fill, stroke);
shape.SetPosition(608400, 1267200);

const docContent = shape.GetDocContent();
const paragraph = docContent.GetElement(0);
paragraph.AddText("Hello World");
slide.AddObject(shape);

const range = shape.GetTextRange();
const text = range.GetText();

const fill2 = Api.CreateSolidFill(Api.RGB(200, 230, 255));
const shape2 = Api.CreateShape("rect", 300 * 36000, 80 * 36000, fill2, stroke);
shape2.SetPosition(608400, 6000000);
const content2 = shape2.GetDocContent();
content2.GetElement(0).AddText("GetText result: " + JSON.stringify(text));
slide.AddObject(shape2);