Word.Interfaces.FieldLoadOptions interface
フィールドを表します。
注釈
重要: 挿入できるフィールドの詳細については、要件セット 1.5 で導入された Word.Range.insertField
API を参照してください。 フィールドの管理のサポートは、Word UI で使用できる内容と似ています。 ただし、Web 上の Word UI では主に読み取り専用のフィールドのみがサポートされていますが (「Word for the web のフィールド コード」を参照)、Addin
フィールドは編集可能です。 フィールドをより完全にサポートする Word UI クライアントの詳細については、「Word のフィールドの挿入、編集、表示」の冒頭にある製品リストを参照してください。
プロパティ
$all | 読み込みオプションに |
code | フィールドのコード命令を指定します。 |
parent |
フィールドの親本文を取得します。 |
parent |
フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は、 |
parent |
フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合、このメソッドは |
parent |
フィールドを含むテーブルを取得します。 テーブルに含まれていない場合は、 |
parent |
フィールドを含むテーブル セルを取得します。 テーブル セルに含まれていない場合は、 |
parent |
フィールドを含むテーブル セルを取得します。 テーブル セルに含まれていない場合、このメソッドは |
parent |
フィールドを含むテーブルを取得します。 テーブルに含まれていない場合、このメソッドは |
result | フィールドの結果データを取得します。 |
プロパティの詳細
$all
読み込みオプションに $all
を指定すると、すべてのスカラー プロパティ ( Range.address
など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color
など) は読み込まれません。
$all?: boolean;
プロパティ値
boolean
code
フィールドのコード命令を指定します。
code?: boolean;
プロパティ値
boolean
注釈
注: コードを設定する機能は、WordApi 1.5 で導入されました。
parentBody
フィールドの親本文を取得します。
parentBody?: Word.Interfaces.BodyLoadOptions;
プロパティ値
注釈
parentContentControl
フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は、 ItemNotFound
エラーをスローします。
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
プロパティ値
注釈
parentContentControlOrNullObject
フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合、このメソッドは isNullObject
プロパティを true
に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
プロパティ値
注釈
parentTable
フィールドを含むテーブルを取得します。 テーブルに含まれていない場合は、 ItemNotFound
エラーをスローします。
parentTable?: Word.Interfaces.TableLoadOptions;
プロパティ値
注釈
parentTableCell
フィールドを含むテーブル セルを取得します。 テーブル セルに含まれていない場合は、 ItemNotFound
エラーをスローします。
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
プロパティ値
注釈
parentTableCellOrNullObject
フィールドを含むテーブル セルを取得します。 テーブル セルに含まれていない場合、このメソッドは isNullObject
プロパティを true
に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
プロパティ値
注釈
parentTableOrNullObject
フィールドを含むテーブルを取得します。 テーブルに含まれていない場合、このメソッドは isNullObject
プロパティを true
に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
プロパティ値
注釈
result
フィールドの結果データを取得します。
result?: Word.Interfaces.RangeLoadOptions;
プロパティ値
注釈
Office Add-ins