Word.Interfaces.BodyLoadOptions interface

文書またはセクションの本文を表します。

プロパティ

$all

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

font

本文のテキスト形式を取得します。 これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。

parentBody

本文の親の本文を取得します。 たとえば、テーブル セル本文の親本文にはヘッダーを指定できます。 親本文がない場合は ItemNotFound エラーをスローします。

parentBodyOrNullObject

本文の親の本文を取得します。 たとえば、テーブル セル本文の親本文にはヘッダーを指定できます。 親本文がない場合、このメソッドは、 isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

parentContentControl

本文を含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は ItemNotFound エラーをスローします。

parentContentControlOrNullObject

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

parentSection

本文の親セクションを取得します。 親セクションがない場合は ItemNotFound エラーをスローします。

parentSectionOrNullObject

本文の親セクションを取得します。 親セクションがない場合、このメソッドは、 isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

style

本文のスタイル名を指定します。 カスタム スタイルとローカライズされたスタイルの名前には、このプロパティを使用します。 ロケール間で移植可能な組み込みスタイルを使用するには、"styleBuiltIn" プロパティを参照してください。

styleBuiltIn

本文の組み込みスタイル名を指定します。 ロケール間で移植可能な組み込みスタイルの場合は、このプロパティを使用します。 カスタム スタイルまたはローカライズされたスタイルの名前を使用するには、"style" プロパティを参照してください。

text

本文のテキストを取得します。 insertText メソッドを使用して、テキストを挿入します。

type

本文の種類を取得します。 種類は、 mainDoc、 section、 header、 footer、または tableCell です。 WordApi 1.5 以降では、 footnote、 endnote、 noteItem の追加の種類がサポートされています。

プロパティの詳細

$all

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

$all?: boolean;

プロパティ値

boolean

font

本文のテキスト形式を取得します。 これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。

font?: Word.Interfaces.FontLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.1

parentBody

本文の親の本文を取得します。 たとえば、テーブル セル本文の親本文にはヘッダーを指定できます。 親本文がない場合は ItemNotFound エラーをスローします。

parentBody?: Word.Interfaces.BodyLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

parentBodyOrNullObject

本文の親の本文を取得します。 たとえば、テーブル セル本文の親本文にはヘッダーを指定できます。 親本文がない場合、このメソッドは、 isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

parentContentControl

本文を含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は ItemNotFound エラーをスローします。

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.1

parentContentControlOrNullObject

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

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

parentSection

本文の親セクションを取得します。 親セクションがない場合は ItemNotFound エラーをスローします。

parentSection?: Word.Interfaces.SectionLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

parentSectionOrNullObject

本文の親セクションを取得します。 親セクションがない場合、このメソッドは、 isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

style

本文のスタイル名を指定します。 カスタム スタイルとローカライズされたスタイルの名前には、このプロパティを使用します。 ロケール間で移植可能な組み込みスタイルを使用するには、"styleBuiltIn" プロパティを参照してください。

style?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

styleBuiltIn

本文の組み込みスタイル名を指定します。 ロケール間で移植可能な組み込みスタイルの場合は、このプロパティを使用します。 カスタム スタイルまたはローカライズされたスタイルの名前を使用するには、"style" プロパティを参照してください。

styleBuiltIn?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.3

text

本文のテキストを取得します。 insertText メソッドを使用して、テキストを挿入します。

text?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

type

本文の種類を取得します。 種類は、 mainDoc、 section、 header、 footer、または tableCell です。 WordApi 1.5 以降では、 footnote、 endnote、 noteItem の追加の種類がサポートされています。

type?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.3