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