Word.Interfaces.FieldUpdateData interface

参考

包:: word

用于更新 Field 对象上的数据的接口，用于在中使用 field.set({ ... })。

属性

code	指定字段的代码指令。
data	指定“Addin”字段中的数据。如果字段不是“Addin”字段，则该字段为 null，并且会在代码尝试设置该字段时引发一般异常。
locked	指定是否锁定字段。 `true` 如果字段已锁定， `false` 则为 ;否则为。
result	获取字段的结果数据。
showCodes	指定是否显示指定字段的域代码。 `true` 如果显示域代码，则为 ; `false` 否则为。

属性详细信息

code

指定字段的代码指令。

code?: string;

属性值

string

注解

[ API 集：WordApi 1.4 ]

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

data

指定“Addin”字段中的数据。如果字段不是“Addin”字段，则该字段为 null，并且会在代码尝试设置该字段时引发一般异常。

data?: string;

属性值

string

注解

[ API 集：WordApi 1.5 ]

locked

指定是否锁定字段。 true 如果字段已锁定， false 则为 ;否则为。

locked?: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.5 ]

result

获取字段的结果数据。

result?: Word.Interfaces.RangeUpdateData;

属性值

Word.Interfaces.RangeUpdateData

注解

[ API 集：WordApi 1.4 ]

showCodes

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

指定是否显示指定字段的域代码。 true 如果显示域代码，则为 ; false 否则为。

showCodes?: boolean;

属性值