Word.Interfaces.FieldUpdateData interface

  • リファレンス
パッケージ:
word

で使用 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;

プロパティ値

Word.Interfaces.RangeUpdateData

注釈

[ API セット: WordApi 1.4 ]

showCodes

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

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

showCodes?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi BETA (プレビューのみ) ]