GetText

Returns the inner text of the current document content object.

Syntax

expression.GetText(options);

expression - A variable that represents a ApiDocumentContent class.

Parameters

Name	Required/Optional	Data type	Default	Description
options	Optional	object		Options for formatting the returned text.
options.Numbering	Optional	boolean	true	Defines if the resulting string will include numbering or not.
options.Math	Optional	boolean	true	Defines if the resulting string will include mathematical expressions or not.
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. Any symbol can be used. The default symbol is "\t".
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".

Returns

string

Example

Extract all text content from a shape in a PDF.

// How do I read all the text that is inside a shape in a PDF?

// Gather the combined text from all paragraphs within a shape in a PDF.

const doc = Api.GetDocument();
const page = doc.GetPage(0);

const fill = Api.CreateSolidFill(Api.HexColor('#E8D5B7'));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = Api.CreateShape('roundRect', Api.MillimetersToEmus(300), Api.MillimetersToEmus(130), fill, stroke);
shape.SetPosition(Api.MillimetersToEmus(20), Api.MillimetersToEmus(35));
const docContent = shape.GetContent();
const paragraph = docContent.GetElement(0);
paragraph.AddText('This is the shape content text.');
const text = docContent.GetText();
const infoParagraph = Api.CreateParagraph();
infoParagraph.AddText('Text from document content: ' + text);
docContent.Push(infoParagraph);
page.AddObject(shape);