跳到主要内容

GetText

从文本块返回文本。

语法

expression.GetText(options);

expression - 表示 ApiRun 类(文本块)的变量。

参数

名称必需/可选数据类型默认值描述
options可选object返回文本的格式选项。
options.NewLineSeparator可选string'\r'定义在结果字符串中如何指定行分隔符。可以使用任何符号。默认分隔符为 "\r"。
options.TabSymbol可选string'\t'定义在结果字符串中如何指定制表符。可以使用任何符号。默认符号为 "\t"。

返回值

string

示例

此示例从文本块返回文本。

// How to get a raw text value.

// Get a run, get its text value and show it in the document.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let run = Api.CreateRun();
run.AddText("\tThis is a text run");
paragraph.AddElement(run);
let text = run.GetText({"NewLineSeparator": "\r", "TabSymbol": "\t"});
paragraph = Api.CreateParagraph();
paragraph.AddText("The text of the specified run: " + text);
doc.Push(paragraph);