金山文档开放平台

主题

回到顶部
本页内容

书签

Bookmarks

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

仅支持 PC 端

Bookmark 对象的集合，这些对象代表指定选定内容、范围或文档中的书签

语法

表达式.ActiveDocument.Bookmarks

表达式：文档类型应用对象

示例 

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // Bookmark 对象的集合，这些对象代表指定选定内容、范围或文档中的书签
  const bookmarks = await app.ActiveDocument.Bookmarks
}

Add()

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

仅支持 PC 端

添加书签

该方法暂不支持移动端

语法

表达式.ActiveDocument.Bookmarks.Add({ Name, Range })

表达式：文档类型应用对象。

参数

Object object

属性数据类型默认值必填说明
Name
String
是
书签名。书签名不能多于一个单词。
Range
Object
是
书签标记的文本区域。可将书签设置到一个折叠的区域（插入点）。

注意：Name 不能含有空格、数字以及. 等特殊符号

Range 说明

属性数据类型默认值必填说明
Start
Number
是
设置书签的起点
End
Number
是
设置书签的终点

示例 

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 书签对象
  const bookmarks = await app.ActiveDocument.Bookmarks

  // 添加书签
  await bookmarks.Add({
    Name: 'WebOffice',
    Range: {
      Start: 1,
      End: 10
    }
  })
}

GetBookmarkText(Name)

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

仅支持 PC 端

获取书签内容

语法

表达式.ActiveDocument.Bookmarks.GetBookmarkText(Name)

表达式：文档类型应用对象。

参数

属性数据类型默认值必填说明
Name
String
是
书签名

返回值

返回对应的书签内容

示例 

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 书签对象
  const bookmarks = await app.ActiveDocument.Bookmarks

  // 添加书签
  await bookmarks.Add({
    Name: 'WebOffice',
    Range: {
      Start: 1,
      End: 10
    }
  })

  // 获取书签内容
  const bookmarkText = await bookmarks.GetBookmarkText('WebOffice')
  console.log(bookmarkText)
}

Json()

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

仅支持 PC 端

获取所有书签

语法

表达式.ActiveDocument.Bookmarks.Json()

表达式：文档类型应用对象。

返回值

属性数据类型说明
name
String
书签名
begin
Number
书签开始位置
end
Number
书签结束位置

示例 

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 添加书签
  await app.ActiveDocument.Bookmarks.Add({
    Name: 'WebOffice',
    Range: {
      Start: 1,
      End: 10
    }
  })

  // 获取所有书签
  const bookmarks = await app.ActiveDocument.Bookmarks.Json()
  console.log(bookmarks)
}

ReplaceBookmark(Data)

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

仅支持 PC 端

替换书签内容

语法

表达式.ActiveDocument.Bookmarks.ReplaceBookmark(Data)

表达式：文档类型应用对象。

参数

Array.<Object>

属性数据类型默认值必填说明
Data
Array.<Object>
是
替换内容结构体

Data 说明

属性数据类型默认值必填说明
name
String
是
替换书签的名字
type
String
是
替换书签的类型（text）
value
String
是
替换书签的新内容

返回值

返回 Boolean，为 true 表示替换成功，否则失败。

示例 

//@file=base.docx
// 获取所有书签
async function example() {
  await instance.ready()

  const app = instance.Application

  // 书签对象
  const bookmarks = await app.ActiveDocument.Bookmarks

  // 添加书签
  await bookmarks.Add({
    Name: 'WebOffice',
    Range: {
      Start: 1,
      End: 10
    }
  })

  // 替换书签内容
  const isReplaceSuccess = await bookmarks.ReplaceBookmark([
    {
      name: 'WebOffice',
      type: 'text',
      value: '替换书签内容'
    }
  ])
  console.log(isReplaceSuccess) // true
}

Item(Name)

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

仅支持 PC 端

书签集合的单个书签

语法

表达式.ActiveDocument.Bookmarks.Item(Name)

表达式：文档类型应用对象

参数

属性数据类型默认值必填说明
Name
String
是
书签名

示例 

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 书签对象
  const bookmarks = await app.ActiveDocument.Bookmarks

  // 添加书签
  await bookmarks.Add({
    Name: 'WebOffice',
    Range: {
      Start: 1,
      End: 10
    }
  })

  // 获取单个书签对象
  await app.ActiveDocument.Bookmarks.Item('WebOffice')
}

Item(Name).Name

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

仅支持 PC 端

获取书签名称

语法

表达式.ActiveDocument.Bookmarks.Item(Name).Name

表达式：文档类型应用对象。

示例 

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 添加书签
  await app.ActiveDocument.Bookmarks.Add({
    Name: 'WebOffice',
    Range: {
      Start: 1,
      End: 10
    }
  })

  // 获取书签名称
  await app.ActiveDocument.Bookmarks.Item('WebOffice').Name
}

Item(Name).Delete()

JSSDK: v1.1.10+、WebOffice v1.67.1+ 支持

仅支持 PC 端

删除书签

语法

表达式.ActiveDocument.Bookmarks.Item(Name).Delete()

表达式：文档类型应用对象。

示例 

//@file=base.docx
async function example() {
  await instance.ready()

  const app = instance.Application

  // 添加书签
  await app.ActiveDocument.Bookmarks.Add({
    Name: 'WebOffice',
    Range: {
      Start: 1,
      End: 10
    }
  })

  // 删除书签
  await app.ActiveDocument.Bookmarks.Item('WebOffice').Delete()
}