Skip to main content

GetText

Returns the bookmark text.

Syntax

expression.GetText(oPr);

expression - A variable that represents a ApiBookmark class.

Parameters

NameRequired/OptionalData typeDefaultDescription
oPrRequiredobjectThe resulting string display properties.
oPr.NumberingOptionalbooleanfalseDefines if the resulting string will include numbering or not.
oPr.MathOptionalbooleanfalseDefines if the resulting string will include mathematical expressions or not.
oPr.NewLineSeparatorOptionalstring'\r'Defines how the line separator will be specified in the resulting string. Any symbol can be used. The default separator is "\r".
oPr.TableCellSeparatorOptionalstring'\t'Defines how the table cell separator will be specified in the resulting string. Any symbol can be used. The default separator is "\t".
oPr.TableRowSeparatorOptionalstring'\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".
oPr.ParaSeparatorOptionalstring'\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".
oPr.TabSymbolOptionalstring'\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