Word.Interfaces.FieldCollectionLoadOptions interface
Word.Field オブジェクトのコレクションを格納します。
注釈
重要: 挿入できるフィールドの詳細については、要件セット 1.5 で導入された Word.Range.insertField API を参照してください。 フィールドの管理のサポートは、Word UI で使用できる内容と似ています。 ただし、Web 上の Word UI では主に読み取り専用のフィールドのみがサポートされていますが (「Word for the web のフィールド コード」を参照)、Addin フィールドは編集可能です。 フィールドをより完全にサポートする Word UI クライアントの詳細については、「Word のフィールドの挿入、編集、表示」の冒頭にある製品リストを参照してください。
プロパティ
| $all | 読み込みオプションに |
| code | コレクション内の各項目について: フィールドのコード命令を指定します。 |
| data | コレクション内の各項目の場合: "Addin" フィールドにデータを指定します。 フィールドが "Addin" フィールドでない場合は、 |
| kind | コレクション内の各項目について: フィールドの種類を取得します。 |
| locked | コレクション内の各項目に対して: フィールドがロックされているかどうかを指定します。
|
| parent |
コレクション内の各項目について: フィールドの親本文を取得します。 |
| parent |
コレクション内の各項目について: フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は、 |
| parent |
コレクション内の各項目について: フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合、このメソッドは |
| parent |
コレクション内の各項目について: フィールドを含むテーブルを取得します。 テーブルに含まれていない場合は、 |
| parent |
コレクション内の各項目について: フィールドを含むテーブル セルを取得します。 テーブル セルに含まれていない場合は、 |
| parent |
コレクション内の各項目について: フィールドを含むテーブル セルを取得します。 テーブル セルに含まれていない場合、このメソッドは |
| parent |
コレクション内の各項目について: フィールドを含むテーブルを取得します。 テーブルに含まれていない場合、このメソッドは |
| result | コレクション内の各項目について: フィールドの結果データを取得します。 |
| type | コレクション内の各項目について: フィールドの型を取得します。 |
プロパティの詳細
$all
読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。
$all?: boolean;プロパティ値
boolean
code
コレクション内の各項目について: フィールドのコード命令を指定します。
code?: boolean;プロパティ値
boolean
注釈
注: コードを設定する機能は、WordApi 1.5 で導入されました。
data
コレクション内の各項目の場合: "Addin" フィールドにデータを指定します。 フィールドが "Addin" フィールドでない場合は、 null され、コードで設定しようとすると一般的な例外がスローされます。
data?: boolean;プロパティ値
boolean
注釈
kind
locked
コレクション内の各項目に対して: フィールドがロックされているかどうかを指定します。
true フィールドがロックされている場合は、それ以外の場合 false 。
locked?: boolean;プロパティ値
boolean
注釈
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;プロパティ値
注釈
type
Office Add-ins