跳到主要内容

GetText

返回书签文本。

语法

expression.GetText(options);

expression - 表示 ApiBookmark 类的变量。

参数

名称必需/可选数据类型默认值描述
options可选object返回文本的格式选项。
options.Numbering可选booleantrue定义结果字符串是否包含编号。
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

示例

此示例展示如何获取书签文本。

// How to add a bookmark and then display its content's text.

// Show a bookmark text in the document.

let doc = Api.GetDocument()
let paragraph = doc.GetElement(0)
paragraph.AddText("ONLYOFFICE Document Builder")
let range1 = doc.GetRange(0, 11)
range1.AddBookmark("BookmarkName")
let bookmark = doc.GetBookmark("BookmarkName")
paragraph.AddLineBreak()
paragraph.AddText("Bookmark text is: " + bookmark.GetText())