Word.Interfaces.FieldUpdateData interface

field.set({ ... }) で使用するために、Field オブジェクトのデータを更新するためのインターフェイス。

注釈

使用元

プロパティ

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;

プロパティ値

注釈

API セット: WordApi 1.4

showCodes

指定したフィールドのフィールド コードを表示するかどうかを指定します。 true フィールド コードが表示されている場合は、それ以外の場合は false します。

showCodes?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.1