Word.Interfaces.FieldLoadOptions interface
フィールドを表します。
注釈
重要: 挿入できるフィールドの詳細については、要件セット 1.5 で導入された Word.Range.insertField API を参照してください。 フィールド管理のサポートは、Word UI で使用できるものと似ています。 ただし、Web 上の Word UI では、主に読み取り専用のフィールドのみがサポートされます (「Word for the web のフィールド コード」を参照してください)。 フィールドをより完全にサポートする Word UI クライアントの詳細については、Word のフィールドの挿入、編集、表示の冒頭にある製品リストを参照してください。
使用元
プロパティ
| $all | 読み込みオプションに |
| code | フィールドのコード命令を指定します。 |
| data |
|
| kind | フィールドの種類を取得します。 |
| link |
フィールドのリンク オプションを表す |
| locked | フィールドがロックされているかどうかを指定します。
|
| ole |
フィールドの OLE 特性 (リンク以外) を表す |
| parent |
フィールドの親本体を取得します。 |
| parent |
フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は |
| parent |
フィールドを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合、このメソッドは、 |
| parent |
フィールドを含むテーブルを取得します。 テーブルに含まれない場合は、 |
| parent |
フィールドを含むテーブル セルを取得します。 テーブル セルに含まれない場合は、 |
| parent |
フィールドを含むテーブル セルを取得します。 テーブルのセルに含まれない場合、このメソッドは、 |
| parent |
フィールドを含むテーブルを取得します。 テーブルに含まれない場合、このメソッドは |
| result | フィールドの結果データを取得します。 |
| show |
指定したフィールドのフィールド コードを表示するかどうかを指定します。
|
| 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
linkFormat
フィールドのリンク オプションを表す LinkFormat オブジェクトを取得します。
linkFormat?: Word.Interfaces.LinkFormatLoadOptions;プロパティ値
注釈
locked
フィールドがロックされているかどうかを指定します。
true フィールドがロックされている場合は、ロックされていない場合は false 。
locked?: boolean;プロパティ値
boolean
注釈
oleFormat
フィールドの OLE 特性 (リンク以外) を表す OleFormat オブジェクトを取得します。
oleFormat?: Word.Interfaces.OleFormatLoadOptions;プロパティ値
注釈
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;プロパティ値
注釈
showCodes
指定したフィールドのフィールド コードを表示するかどうかを指定します。
true フィールド コードが表示されている場合は、それ以外の場合は false します。
showCodes?: boolean;プロパティ値
boolean