次の方法で共有


Word.Interfaces.FieldCollectionLoadOptions interface

Word.Field オブジェクトのコレクションを格納します。

注釈

[ API セット: WordApi 1.4 ]

重要: 挿入できるフィールドの詳細については、要件セット 1.5 で導入された Word.Range.insertField API を参照してください。 フィールドの管理のサポートは、Word UI で使用できる内容と似ています。 ただし、Web 上の Word UI では主に読み取り専用のフィールドのみがサポートされていますが (「Word for the web のフィールド コード」を参照)、Addin フィールドは編集可能です。 フィールドをより完全にサポートする Word UI クライアントの詳細については、「Word フィールドの挿入、編集、表示」の冒頭にある製品リストを参照してください。

プロパティ

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

code

コレクション内の各項目について: フィールドのコード命令を指定します。

data

コレクション内の各項目の場合: "Addin" フィールドにデータを指定します。 フィールドが "Addin" フィールドでない場合は、 null され、コードで設定しようとすると一般的な例外がスローされます。

kind

コレクション内の各項目について: フィールドの種類を取得します。

locked

コレクション内の各項目に対して: フィールドがロックされているかどうかを指定します。 true フィールドがロックされている場合は、それ以外の場合 false

parentBody

コレクション内の各項目について: フィールドの親本文を取得します。

parentContentControl

コレクション内の各項目について: フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は、 ItemNotFound エラーをスローします。

parentContentControlOrNullObject

コレクション内の各項目について: フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

parentTable

コレクション内の各項目について: フィールドを含むテーブルを取得します。 テーブルに含まれていない場合は、 ItemNotFound エラーをスローします。

parentTableCell

コレクション内の各項目について: フィールドを含むテーブル セルを取得します。 テーブル セルに含まれていない場合は、 ItemNotFound エラーをスローします。

parentTableCellOrNullObject

コレクション内の各項目について: フィールドを含むテーブル セルを取得します。 テーブル セルに含まれていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

parentTableOrNullObject

コレクション内の各項目について: フィールドを含むテーブルを取得します。 テーブルに含まれていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

result

コレクション内の各項目について: フィールドの結果データを取得します。

type

コレクション内の各項目について: フィールドの型を取得します。

プロパティの詳細

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

$all?: boolean;

プロパティ値

boolean

code

コレクション内の各項目について: フィールドのコード命令を指定します。

code?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.4 ]

注: コードを設定する機能は、WordApi 1.5 で導入されました。

data

コレクション内の各項目の場合: "Addin" フィールドにデータを指定します。 フィールドが "Addin" フィールドでない場合は、 null され、コードで設定しようとすると一般的な例外がスローされます。

data?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

kind

コレクション内の各項目について: フィールドの種類を取得します。

kind?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

locked

コレクション内の各項目に対して: フィールドがロックされているかどうかを指定します。 true フィールドがロックされている場合は、それ以外の場合 false

locked?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

parentBody

コレクション内の各項目について: フィールドの親本文を取得します。

parentBody?: Word.Interfaces.BodyLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.4 ]

parentContentControl

コレクション内の各項目について: フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は、 ItemNotFound エラーをスローします。

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.4 ]

parentContentControlOrNullObject

コレクション内の各項目について: フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.4 ]

parentTable

コレクション内の各項目について: フィールドを含むテーブルを取得します。 テーブルに含まれていない場合は、 ItemNotFound エラーをスローします。

parentTable?: Word.Interfaces.TableLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.4 ]

parentTableCell

コレクション内の各項目について: フィールドを含むテーブル セルを取得します。 テーブル セルに含まれていない場合は、 ItemNotFound エラーをスローします。

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.4 ]

parentTableCellOrNullObject

コレクション内の各項目について: フィールドを含むテーブル セルを取得します。 テーブル セルに含まれていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.4 ]

parentTableOrNullObject

コレクション内の各項目について: フィールドを含むテーブルを取得します。 テーブルに含まれていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.4 ]

result

コレクション内の各項目について: フィールドの結果データを取得します。

result?: Word.Interfaces.RangeLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.4 ]

type

コレクション内の各項目について: フィールドの型を取得します。

type?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]