Word.Interfaces.FieldCollectionLoadOptions interface

包含Word的集合。Field 对象。

注解

[ API 集:WordApi 1.4 ]

重要说明:若要详细了解可以插入哪些字段,请参阅 Word.Range.insertField API 要求集 1.5 中引入的 。 对管理字段的支持与Word UI 中提供的支持类似。 但是,虽然 Web 上的Word UI 主要仅支持将字段作为只读 (请参阅 web ) Word 中的域代码,但Addin字段是可编辑的。 若要详细了解Word更完全支持字段的 UI 客户端,请参阅Word中插入、编辑和查看字段开头的产品列表。

属性

$all

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

code

对于集合中的每个项:指定字段的代码指令。

data

对于集合中的每个项:指定“Addin”字段中的数据。 如果字段不是“Addin”字段,则 null 为 ,并且会在代码尝试设置该字段时引发一般异常。

kind

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

locked

对于集合中的每个项:指定是否锁定字段。 true 如果字段已锁定, false 则为 ;否则为 。

parentBody

对于集合中的每个项:获取字段的父正文。

parentContentControl

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

parentContentControlOrNullObject

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

parentTable

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

parentTableCell

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

parentTableCellOrNullObject

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

parentTableOrNullObject

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

result

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

showCodes

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

type

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

属性详细信息

$all

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

$all?: boolean;

属性值

boolean

code

对于集合中的每个项:指定字段的代码指令。

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 ]

locked

对于集合中的每个项:指定是否锁定字段。 true 如果字段已锁定, false 则为 ;否则为 。

locked?: boolean;

属性值

boolean

注解

[ API 集:WordApi 1.5 ]

parentBody

对于集合中的每个项:获取字段的父正文。

parentBody?: Word.Interfaces.BodyLoadOptions;

属性值

注解

[ API 集:WordApi 1.4 ]

parentContentControl

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

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

属性值

注解

[ API 集:WordApi 1.4 ]

parentContentControlOrNullObject

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

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

属性值

注解

[ API 集:WordApi 1.4 ]

parentTable

对于集合中的每个项:获取包含 字段的表。 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

对于集合中的每个项:获取包含 字段的表。 如果它未包含在表中,则此方法将返回一个 对象,其 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 ]