Bookmark
Bookmark
书签对象
属性
name
JSSDK: 1.2.2、zOffice2022.3 FP2 支持
书签对象的名称
语法
bookmark.name
bookmark: 书签对象
返回值
name: Promise<string>
示例
async function example() {
const bookmark = await Application.ActiveDocument.Bookmarks.item(1);
const name = await bookmark.name;
}
range
JSSDK: 1.2.2、zOffice2022.3 FP2 支持
获取书签所在范围
语法
bookmark.range
bookmark: 书签对象
返回值
Promise<Word.Range>
示例
async function example() {
const bookmark = await Application.ActiveDocument.Bookmarks.item(1);
const range = await bookmark.range;
}
方法
delete
JSSDK: 1.2.2、zOffice2022.3 FP2 支持
删除书签
语法
bookmark.delete()
bookmark: 书签对象
返回值
Promise<boolean> 是否删除成功
示例
async function example(app, name) {
let success = false;
const bookmark = await Application.ActiveDocument.Bookmarks.item(name);
if (bookMark) success = await bookmark.delete();
}
focus
JSSDK: 1.0.3、zOffice2022.1 FP3 支持
定位书签
语法
bookmark.focus()
bookmark: 书签对象
返回值
Promise<boolean> 是否定位成功
示例
async function example(app, name) {
let success = false;
const bookmark = await Application.ActiveDocument.Bookmarks.item(name);
if (bookMark) success = await bookmark.focus();
}
getHtml
JSSDK: 1.2.0、zOffice2022.3 支持
获取书签位置的Html结构
语法
bookmark.getHtml()
bookmark: 书签对象
返回值
Promise<string> 书签位置的Html字符串
示例
async function example() {
const bookmark = await Application.ActiveDocument.Bookmarks.item(1);
const htmlString = await bookmark.getHtml();
}
getText
JSSDK: 1.2.0、zOffice2022.3 支持
获取书签位置的文本结构
语法
bookmark.getText()
bookmark: 书签对象
返回值
Promise<string>
示例
async function example() {
const bookmark = await Application.ActiveDocument.Bookmarks.item(1);
const res = await bookmark.getText();
}
getContent
JSSDK: 1.7.22、zOffice V7.2 FP3 支持
获取书签区域的JSON数据
语法
bookmark.getContent()
bookmark: 书签对象
返回值
Promise<any>书签的JSON对象及JSON的版本
| 属性 | 数据类型 | 说明 |
|---|---|---|
| version | string | json数据版本 |
| data | any[] | 书签区域内容的JSON数据 |
示例
async function example() {
const bookmark = await Application.ActiveDocument.Bookmarks.item(1);
const res = await bookmark.getContent();
}
setHtml
JSSDK: 1.2.0、zOffice2022.3 支持
设置书签位置的Html结构
语法
bookmark.setHtml()
bookmark: 书签对象
参数
| 属性 | 数据类型 | 必填 | 说明 |
|---|---|---|---|
| htmlString | string | 是 | Html结构 |
返回值
Promise<boolean> 是否设置成功
示例
async function example() {
const htmlString = '<span >new Html</span>';
const bookmark = await Application.ActiveDocument.Bookmarks.item(1);
const success = await bookmark.setHtml(htmlString);
}
setText
设置书签位置的文本
语法
bookmark.setText()
bookmark: 书签对象
返回值
Promise<boolean> 文本是否设置成功
参数
| 属性 | 数据类型 | 必填 | 说明 |
|---|---|---|---|
| content | string | 是 | 书签位置的文本 |
示例
async function example(content) {
const bookmark = await Application.ActiveDocument.Bookmarks.item(1);
const success = await bookmark.setText(content);
}
setContent
JSSDK: 1.7.22、zOffice V7.2 FP3 支持
根据传入的JSON数据，设置书签区域内容（JSON数据仅支持由bookmark.getContent()获取）
语法
bookmark.setContent(content)
bookmark: 书签对象
返回值
Promise<boolean> 数据是否设置成功（true:设置成功 false:设置失败）
参数
| 属性 | 数据类型 | 必填 | 说明 |
|---|---|---|---|
| content | any[] | 书签区域内容的JSON数据 |
示例
async function example() {
// 获取第一个书签的json数据
const bookmark = await Application.ActiveDocument.Bookmarks.item(1);
const content = await bookmark.getContent();
// 为第二个书签设置书签1的json数据
const bookmark = await Application.ActiveDocument.Bookmarks.item(2);
const success = await bookmark.setContent(content.data);
}
setTextCandidates
为指定书签添加预设值（为书签添加预设值后，光标进入到该书签区域时，书签尾部会显示一个小按钮，点击小按钮，预设值会显示在下拉列表里，点击某个预设值，会用此预设置替换掉该书签的内容）
语法
Bookmark.setTextCandidates(candidates)
Bookmark: 书签对象
参数
| 属性 | 数据类型 | 必填 | 说明 |
|---|---|---|---|
| candidates | string[] | 是 | 该书签对应的预设值数组 |
返回值
Promise<boolean>
示例
async function example() {
const bookmark = await Application.ActiveDocument.Bookmarks.item('test');
const success = await bookmark.setTextCandidates([
'A公司',
'B公司'
]);
}