WebOffice 开放平台

主题

回到顶部
本页内容

域(Fields)

返回一个 Fields 集合，该集合代表文档中的所有域，此为只读属性。

在当前版本的 Word（文档）中，在用户使用 @ 人插件后调用有效果。

属性列表

属性说明
Count
获取文档中的所有域的数量

方法列表

方法说明
List()
获取文档中的所有域的列表
Item()
返回集合中的单个 Field 对象
Item().Code
文档中的单个域的 Code
Item().Type
文档中的单个域的类型

Count

获取文档中的所有域的数量

在当前版本的 Word（文档）中，在用户使用 @ 人插件后调用有效果，例如插入一个 @ 人就会有 1 项 Item

语法

表达式.ActiveDocument.Fields.Count

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

示例

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

  const app = instance.Application

  // 返回一个 Fields 对象
  const Fields = await app.ActiveDocument.Fields

  // 获取文档中的所有域的数量
  const Count = await Fields.Count
  console.log(Count)
}

List()

获取文档中的所有域的列表

在当前版本的 Word（文档）中，在用户使用 @ 人插件后调用有效果，例如插入一个 @ 人就会有 1 项 Item

语法

表达式.ActiveDocument.Fields.List()

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

示例

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

  const app = instance.Application

  // 返回一个 Fields 对象
  const Fields = await app.ActiveDocument.Fields

  // 获取文档中的所有域的列表
  const List = await Fields.List()
  console.log(List)
}

Item()

返回集合中的单个 Field 对象

在当前版本的 Word（文档）中，在用户使用 @ 人插件后调用有效果，例如插入一个 @ 人就会有 1 项 Item

语法

表达式.ActiveDocument.Fields.Item(Index)

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

示例

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

  const app = instance.Application

  // 返回一个 Fields 对象
  const Fields = await app.ActiveDocument.Fields

  // 返回单个 Field 对象
  const Field = await Fields.Item(1)
}

Item().Code

文档中的单个域的 Code

在当前版本的 Word（文档）中，在用户使用 @ 人插件后调用有效果，例如插入一个 @ 人就会有 1 项 Item

语法

表达式.ActiveDocument.Fields.Item(Index).Code

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

示例

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

  const app = instance.Application

  // 返回一个 Fields 对象
  const Fields = await app.ActiveDocument.Fields

  // 返回单个 Field 对象
  const Field = await Fields.Item(1)

  // 文档中的单个域的 Code
  const Code = await Field.Code
  console.log(Code)
}

Item().Type

文档中的单个域的类型

在当前版本的 Word（文档）中，在用户使用 @ 人插件后调用有效果，例如插入一个 @ 人就会有 1 项 Item

语法

表达式.ActiveDocument.Fields.Item(Index).Type

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

示例

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

  const app = instance.Application

  // 返回一个 Fields 对象
  const Fields = await app.ActiveDocument.Fields

  // 返回单个 Field 对象
  const Field = await Fields.Item(1)

  // 文档中的单个域的类型
  const Type = await Field.Type
  console.log(Type)
}