GetText
function GetText(
oPr: object = null,
oPr.NewLineParagraph: boolean = false,
oPr.Numbering: boolean = false,
oPr.Math: boolean = false,
oPr.NewLineSeparator: string = '\r',
oPr.TableCellSeparator: string = '\t',
oPr.TableRowSeparator: string = '\r\n',
oPr.ParaSeparator: string = '\r\n',
oPr.TabSymbol: string = '\t',
): StringDescription
Returns a text from the specified range.
Parameters
- oPr
objectdefault: null The resulting string display properties.
- oPr.NewLineParagraph
booleandefault: false Defines if the resulting string will include paragraph line boundaries or not.
- oPr.Numbering
booleandefault: false Defines if the resulting string will include numbering or not.
- oPr.Math
booleandefault: false Defines if the resulting string will include mathematical expressions or not.
- oPr.NewLineSeparator
stringdefault: '\r' Defines how the line separator will be specified in the resulting string.
- oPr.TableCellSeparator
stringdefault: '\t' Defines how the table cell separator will be specified in the resulting string.
- oPr.TableRowSeparator
stringdefault: '\r\n' Defines how the table row separator will be specified in the resulting string.
- oPr.ParaSeparator
stringdefault: '\r\n' Defines how the paragraph separator will be specified in the resulting string.
- oPr.TabSymbol
stringdefault: '\t' Defines how the tab will be specified in the resulting string (does not apply to numbering)
Returns
StringTry It
var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
oParagraph.AddText("\tONLYOFFICE Document Builder");
var oRange = oDocument.GetRange(0, 24);
var sText = oRange.GetText({"Numbering": true, "Math": true, "NewLineSeparator": "\r", "TabSymbol": "\t", "NewLineParagraph": true, "TableCellSeparator": "\t", "TableRowSeparator": "\r\n", "ParaSeparator": "\r\n"});
oParagraph = Api.CreateParagraph();
oParagraph.AddText("The text of the specified range: " + sText);
oDocument.Push(oParagraph);