跳到主要内容

GetText

返回当前文档内容对象的内部文本。

语法​

expression.GetText(options);

expression - 表示 ApiDocumentContent 类的变量。

参数​

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

返回值​

string

示例​

此示例展示如何从形状的文档内容中获取所有文本。

const worksheet = Api.GetActiveSheet();

const fill = Api.CreateSolidFill(Api.RGB(89, 130, 190));
const stroke = Api.CreateStroke(0, Api.CreateNoFill());
const shape = worksheet.AddShape(
	'roundRect',
	Api.MillimetersToEmus(70), Api.MillimetersToEmus(25),
	fill, stroke,
	0, 0, 2, 0
);

const content = shape.GetContent();
const paragraph = content.GetElement(0);
paragraph.AddText('Hello, world!');
paragraph.AddLineBreak();

const run = Api.CreateRun();
run.AddText('Text from run.');
paragraph.AddElement(run);

const text = content.GetText();
worksheet.GetRange('A1').SetValue('Text: ' + text);