次の方法で共有


Word.Interfaces.FieldLoadOptions interface

フィールドを表します。

注釈

[ API セット: WordApi 1.4 ]

重要: 挿入できるフィールドの詳細については、要件セット 1.5 で導入された Word.Range.insertField API を参照してください。 フィールドの管理のサポートは、Word UI で使用できる内容と似ています。 ただし、web 上のWord UI は主に読み取り専用としてフィールドをサポートします (「web のWordのフィールド コード」を参照)、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

フィールドの結果データを取得します。

showCodes

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

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 ]

showCodes

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

showCodes?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApiDesktop 1.1 ]

type

フィールドの型を取得します。

type?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]