Word.Interfaces.FieldCollectionLoadOptions interface

Word のコレクションが含まれています。フィールド オブジェクト。

注釈

API セット: WordApi 1.4

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

使用元

プロパティ

$all

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

code

For EACH ITEM in the collection: フィールドのコード命令を指定します。

data

For each ITEM in the collection: addin 型のフィールドのデータを指定します。 フィールドが addin 型でない場合は null であり、コードがそれを設定しようとすると、一般的な例外がスローされます。

kind

For each ITEM in the collection: フィールドの種類を取得します。

linkFormat

For each ITEM in the collection: フィールドのリンク オプションを表す LinkFormat オブジェクトを取得します。

locked

For each ITEM in the collection: フィールドがロックされているかどうかを指定します。 true フィールドがロックされている場合は、ロックされていない場合は false

oleFormat

For each ITEM in the collection: フィールドの OLE 属性 (リンク以外) を表す OleFormat オブジェクトを取得します。

parentBody

For each ITEM in the collection: フィールドの親本文を取得します。

parentContentControl

For each ITEM in the collection: フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は ItemNotFound エラーをスローします。

parentContentControlOrNullObject

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

parentTable

For each ITEM in the collection: フィールドを含むテーブルを取得します。 テーブルに含まれない場合は、 ItemNotFound エラーをスローします。

parentTableCell

For each ITEM in the collection: フィールドを含むテーブル セルを取得します。 テーブル セルに含まれない場合は、 ItemNotFound エラーをスローします。

parentTableCellOrNullObject

For each ITEM in the collection: フィールドを含むテーブル セルを取得します。 テーブルのセルに含まれない場合、このメソッドは、 isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

parentTableOrNullObject

For each ITEM in the collection: フィールドを含むテーブルを取得します。 テーブルに含まれない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

result

For each ITEM in the collection: フィールドの結果データを取得します。

showCodes

コレクション内の各アイテムの場合: 指定したフィールドにフィールド コードを表示するかどうかを指定します。 true フィールド コードが表示されている場合は、それ以外の場合は false します。

type

For each ITEM in the collection: フィールドの型を取得します。

プロパティの詳細

$all

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

$all?: boolean;

プロパティ値

boolean

code

For EACH ITEM in the collection: フィールドのコード命令を指定します。

code?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.4

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

data

For each ITEM in the collection: addin 型のフィールドのデータを指定します。 フィールドが addin 型でない場合は null であり、コードがそれを設定しようとすると、一般的な例外がスローされます。

data?: boolean;

プロパティ値

boolean

注釈

API セット: WordAPI 1.5

kind

For each ITEM in the collection: フィールドの種類を取得します。

kind?: boolean;

プロパティ値

boolean

注釈

API セット: WordAPI 1.5

linkFormat

For each ITEM in the collection: フィールドのリンク オプションを表す LinkFormat オブジェクトを取得します。

linkFormat?: Word.Interfaces.LinkFormatLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

locked

For each ITEM in the collection: フィールドがロックされているかどうかを指定します。 true フィールドがロックされている場合は、ロックされていない場合は false

locked?: boolean;

プロパティ値

boolean

注釈

API セット: WordAPI 1.5

oleFormat

For each ITEM in the collection: フィールドの OLE 属性 (リンク以外) を表す OleFormat オブジェクトを取得します。

oleFormat?: Word.Interfaces.OleFormatLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

parentBody

For each ITEM in the collection: フィールドの親本文を取得します。

parentBody?: Word.Interfaces.BodyLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.4

parentContentControl

For each ITEM in the collection: フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は ItemNotFound エラーをスローします。

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.4

parentContentControlOrNullObject

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

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.4

parentTable

For each ITEM in the collection: フィールドを含むテーブルを取得します。 テーブルに含まれない場合は、 ItemNotFound エラーをスローします。

parentTable?: Word.Interfaces.TableLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.4

parentTableCell

For each ITEM in the collection: フィールドを含むテーブル セルを取得します。 テーブル セルに含まれない場合は、 ItemNotFound エラーをスローします。

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.4

parentTableCellOrNullObject

For each ITEM in the collection: フィールドを含むテーブル セルを取得します。 テーブルのセルに含まれない場合、このメソッドは、 isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.4

parentTableOrNullObject

For each ITEM in the collection: フィールドを含むテーブルを取得します。 テーブルに含まれない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.4

result

For each ITEM in the collection: フィールドの結果データを取得します。

result?: Word.Interfaces.RangeLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.4

showCodes

コレクション内の各アイテムの場合: 指定したフィールドにフィールド コードを表示するかどうかを指定します。 true フィールド コードが表示されている場合は、それ以外の場合は false します。

showCodes?: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.1

type

For each ITEM in the collection: フィールドの型を取得します。

type?: boolean;

プロパティ値

boolean

注釈

API セット: WordAPI 1.5