GetText
Returns the bookmark text.
Syntax
expression.GetText(oPr, oPr.NewLineParagraph, oPr.Numbering, oPr.Math, oPr.NewLineSeparator, oPr.TableCellSeparator, oPr.TableRowSeparator, oPr.ParaSeparator, oPr.TabSymbol);
expression
- A variable that represents a ApiBookmark class.
Parameters
Name | Required/Optional | Data type | Default | Description |
---|---|---|---|---|
oPr | Required | object | The resulting string display properties. | |
oPr.NewLineParagraph | Optional | boolean | false | Defines if the resulting string will include paragraph line boundaries or not. |
oPr.Numbering | Optional | boolean | false | Defines if the resulting string will include numbering or not. |
oPr.Math | Optional | boolean | false | Defines if the resulting string will include mathematical expressions or not. |
oPr.NewLineSeparator | Optional | string | '\r' | Defines how the line separator will be specified in the resulting string. |
oPr.TableCellSeparator | Optional | string | '\t' | Defines how the table cell separator will be specified in the resulting string. |
oPr.TableRowSeparator | Optional | string | '\r\n' | Defines how the table row separator will be specified in the resulting string. |
oPr.ParaSeparator | Optional | string | '\r\n' | Defines how the paragraph separator will be specified in the resulting string. |
oPr.TabSymbol | Optional | string | '\t' | Defines how the tab will be specified in the resulting string (does not apply to numbering). |
Returns
string