Word.Interfaces.FieldCollectionLoadOptions interface

包含 Word 集合。字段对象。

注解

API 集:WordApi 1.4

重要提示:要详细了解可以插入哪些字段,请参阅要求集 1.5 中引入的 Word.Range.insertField API。 对字段管理的支持类似于 Word UI 中提供的功能。 但是,Web 上的 Word UI 主要仅支持只读字段, (请参阅 Word 网页版中的字段代码) 。 若要深入了解更完全支持字段的 Word UI 客户端,请参阅“在 Word 中插入、编辑和查看字段”开头的产品列表。

使用方

属性

$all

指定加载选项将 $all 加载所有标量属性 ((如 Range.address) ),但不会加载导航属性 ((如 Range.format.fill.color) )。

code

For EACH ITEM in the collection: 指定字段的代码指令。

data

对于集合中的每个项目: 指定类型字段 addin 中的数据。 如果字段不是一个 addin 类型,它就是 null ,当代码尝试设置它时,它将引发常规异常。

kind

对于集合中的每个项: 获取字段的种类。

linkFormat

For EACH ITEM in the collection: 获取表示 LinkFormat 字段链接选项的对象。

locked

For EACH ITEM in the collection: 指定字段是否已锁定。 true 如果该字段已锁定, false 则为否。

oleFormat

For EACH ITEM in the collection: 获取表示 OleFormat 字段链接) 以外的 OLE 特征 (对象。

parentBody

For EACH ITEM in the collection: 获取字段的父正文。

parentContentControl

对于集合中的每个项: 获取包含该字段的内容控件。 如果没有父内容控件,则引发 ItemNotFound 错误。

parentContentControlOrNullObject

对于集合中的每个项: 获取包含该字段的内容控件。 如果没有父内容控件,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTable

For EACH ITEM in the collection: 获取包含字段的表。 如果表中未包含,则引发 ItemNotFound 错误。

parentTableCell

对于集合中的每个项: 获取包含字段的表单元格。 如果表单元格中未包含错误,则引发 ItemNotFound 错误。

parentTableCellOrNullObject

对于集合中的每个项: 获取包含字段的表单元格。 如果它未包含在表单元格中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTableOrNullObject

For EACH ITEM in the collection: 获取包含字段的表。 如果它未包含在表中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

result

对于集合中的每个项目: 获取字段的结果数据。

showCodes

对于集合中的每个项:指定是否显示指定字段的字段代码。 true 如果显示域代码, false 否则。

type

对于集合中的每个项: 获取字段的类型。

属性详细信息

$all

指定加载选项将 $all 加载所有标量属性 ((如 Range.address) ),但不会加载导航属性 ((如 Range.format.fill.color) )。

$all?: boolean;

属性值

boolean

code

For EACH ITEM in the collection: 指定字段的代码指令。

code?: boolean;

属性值

boolean

注解

API 集:WordApi 1.4

注意:WordApi 1.5 中引入了设置代码的功能。

data

对于集合中的每个项目: 指定类型字段 addin 中的数据。 如果字段不是一个 addin 类型,它就是 null ,当代码尝试设置它时,它将引发常规异常。

data?: boolean;

属性值

boolean

注解

API 集:WordApi 1.5

kind

对于集合中的每个项: 获取字段的种类。

kind?: boolean;

属性值

boolean

注解

API 集:WordApi 1.5

linkFormat

For EACH ITEM in the collection: 获取表示 LinkFormat 字段链接选项的对象。

linkFormat?: Word.Interfaces.LinkFormatLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.4

locked

For EACH ITEM in the collection: 指定字段是否已锁定。 true 如果该字段已锁定, false 则为否。

locked?: boolean;

属性值

boolean

注解

API 集:WordApi 1.5

oleFormat

For EACH ITEM in the collection: 获取表示 OleFormat 字段链接) 以外的 OLE 特征 (对象。

oleFormat?: Word.Interfaces.OleFormatLoadOptions;

属性值

注解

API 集:WordApiDesktop 1.4

parentBody

For EACH ITEM in the collection: 获取字段的父正文。

parentBody?: Word.Interfaces.BodyLoadOptions;

属性值

注解

API 集:WordApi 1.4

parentContentControl

对于集合中的每个项: 获取包含该字段的内容控件。 如果没有父内容控件,则引发 ItemNotFound 错误。

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

属性值

注解

API 集:WordApi 1.4

parentContentControlOrNullObject

对于集合中的每个项: 获取包含该字段的内容控件。 如果没有父内容控件,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

属性值

注解

API 集:WordApi 1.4

parentTable

For EACH ITEM in the collection: 获取包含字段的表。 如果表中未包含,则引发 ItemNotFound 错误。

parentTable?: Word.Interfaces.TableLoadOptions;

属性值

注解

API 集:WordApi 1.4

parentTableCell

对于集合中的每个项: 获取包含字段的表单元格。 如果表单元格中未包含错误,则引发 ItemNotFound 错误。

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

属性值

注解

API 集:WordApi 1.4

parentTableCellOrNullObject

对于集合中的每个项: 获取包含字段的表单元格。 如果它未包含在表单元格中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

属性值

注解

API 集:WordApi 1.4

parentTableOrNullObject

For EACH ITEM in the collection: 获取包含字段的表。 如果它未包含在表中,则此方法将返回其 isNullObject 属性设置为 true的对象。 有关详细信息,请参阅 *OrNullObject 方法和属性

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

属性值

注解

API 集:WordApi 1.4

result

对于集合中的每个项目: 获取字段的结果数据。

result?: Word.Interfaces.RangeLoadOptions;

属性值

注解

API 集:WordApi 1.4

showCodes

对于集合中的每个项:指定是否显示指定字段的字段代码。 true 如果显示域代码, false 否则。

showCodes?: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.1

type

对于集合中的每个项: 获取字段的类型。

type?: boolean;

属性值

boolean

注解

API 集:WordApi 1.5