跳到主要内容

GetText

返回范围的文本内容。段落分隔符表示为 "\r"。

语法​

expression.GetText(options);

expression - 表示 ApiTextRange 类的变量。

参数​

名称必需/可选数据类型默认值描述
options可选object返回文本的格式选项。
options.Math可选booleantrue定义结果字符串是否包含数学表达式。
options.NewLineSeparator可选string'\r'定义在结果字符串中如何指定行分隔符。可以使用任何符号。默认分隔符为 “\r”。
options.TableCellSeparator可选string'\t'定义在结果字符串中如何指定表格单元格分隔符。可以使用任何符号。默认分隔符为 “\t”。
options.TableRowSeparator可选string'\r\n'定义在结果字符串中如何指定表格行分隔符。可以使用任何符号。默认分隔符为 “\r\n”。
options.ParaSeparator可选string'\r\n'定义在结果字符串中如何指定段落分隔符。可以使用任何符号。默认分隔符为 “\r\n”。
options.TabSymbol可选string'\t'定义在结果字符串中如何指定制表符（不适用于编号）。可以使用任何符号。默认符号为 “\t”。

返回值​

string

示例​

在工作表的形状中读取文本范围所包含的文本。

// The range of a whole text body returns every character it holds.

// Read the text of the range.

let worksheet = Api.GetActiveSheet();
let fill = Api.CreateSolidFill(Api.RGB(255, 111, 61));
let stroke = Api.CreateStroke(0, Api.CreateNoFill());
let shape = worksheet.AddShape("rect", 200 * 36000, 80 * 36000, fill, stroke, 3, 0, 1, 0);

let docContent = shape.GetContent();
let paragraph = docContent.GetElement(0);
paragraph.AddText("Hello World");

let range = shape.GetTextRange();

let text = range.GetText();

worksheet.GetRange("A1").SetValue("GetText: " + text);