Word.Interfaces.ParagraphLoadOptions interface

選択部分、範囲、コンテンツ コントロール、または文書本文に含まれる 1 つの段落を表します。

プロパティ

$all

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

alignment

段落の配置を指定します。 値には、 leftcenteredright、または justified を指定できます。

firstLineIndent

1 行目またはぶら下げているインデントの値をポイント単位で指定します。 最初の行のインデントを設定するのには正の値を使用し、ぶら下げインデントを設定するのには負の値を使用します。

font

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

isLastParagraph

段落がその親の本文内の最後の段落であることを示します。

isListItem

段落がリスト アイテムであるかどうかを確認します。

leftIndent

段落の左インデント値を指定します (ポイント単位)。

lineSpacing

指定した段落の行間隔をポイント単位で指定します。 Word UI では、この値が 12 で除算されます。

lineUnitAfter

段落の後の間隔の長さをグリッド線で指定します。

lineUnitBefore

段落の前の間隔をグリッド線で指定します。

list

この段落が属するリストを取得します。 段落がリストにない場合は ItemNotFound エラーをスローします。

listItem

段落の ListItem を取得します。 段落がリストに含まれていない場合は、 ItemNotFound エラーをスローします。

listItemOrNullObject

段落の ListItem を取得します。 段落がリストの一部ではない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

listOrNullObject

この段落が属するリストを取得します。 段落がリスト内にない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

outlineLevel

段落のアウトライン レベルを指定します。

parentBody

段落の親の本文を取得します。

parentContentControl

段落を格納しているコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は ItemNotFound エラーをスローします。

parentContentControlOrNullObject

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

parentTable

段落を含むテーブルを取得します。 テーブルに含まれない場合は、 ItemNotFound エラーをスローします。

parentTableCell

段落を含むテーブルのセルを取得します。 テーブル セルに含まれない場合は、 ItemNotFound エラーをスローします。

parentTableCellOrNullObject

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

parentTableOrNullObject

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

rightIndent

段落の右インデント値を指定します (ポイント単位)。

shading

段落の網かけ形式を参照する ShadingUniversal オブジェクトを返します。

spaceAfter

段落の後の間隔を指定します (ポイント単位)。

spaceBefore

段落の前の間隔を指定します (ポイント単位)。

style

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

styleBuiltIn

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

tableNestingLevel

段落のテーブルのレベルを取得します。 段落が表内にない場合は 0 を返します。

text

段落のテキストを取得します。

uniqueLocalId

現在のセッションの段落識別子を表す文字列を取得します。 ID は、中かっこのない標準の 8-4-4-4-12 GUID 形式であり、セッションおよび共同作成者によって異なります。

プロパティの詳細

$all

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

$all?: boolean;

プロパティ値

boolean

alignment

段落の配置を指定します。 値には、 leftcenteredright、または justified を指定できます。

alignment?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

firstLineIndent

1 行目またはぶら下げているインデントの値をポイント単位で指定します。 最初の行のインデントを設定するのには正の値を使用し、ぶら下げインデントを設定するのには負の値を使用します。

firstLineIndent?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

font

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

font?: Word.Interfaces.FontLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.1

isLastParagraph

段落がその親の本文内の最後の段落であることを示します。

isLastParagraph?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.3

isListItem

段落がリスト アイテムであるかどうかを確認します。

isListItem?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.3

leftIndent

段落の左インデント値を指定します (ポイント単位)。

leftIndent?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

lineSpacing

指定した段落の行間隔をポイント単位で指定します。 Word UI では、この値が 12 で除算されます。

lineSpacing?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

lineUnitAfter

段落の後の間隔の長さをグリッド線で指定します。

lineUnitAfter?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

lineUnitBefore

段落の前の間隔をグリッド線で指定します。

lineUnitBefore?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

list

この段落が属するリストを取得します。 段落がリストにない場合は ItemNotFound エラーをスローします。

list?: Word.Interfaces.ListLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

listItem

段落の ListItem を取得します。 段落がリストに含まれていない場合は、 ItemNotFound エラーをスローします。

listItem?: Word.Interfaces.ListItemLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

listItemOrNullObject

段落の ListItem を取得します。 段落がリストの一部ではない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

listOrNullObject

この段落が属するリストを取得します。 段落がリスト内にない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

listOrNullObject?: Word.Interfaces.ListLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

outlineLevel

段落のアウトライン レベルを指定します。

outlineLevel?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

parentBody

段落の親の本文を取得します。

parentBody?: 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

parentTable

段落を含むテーブルを取得します。 テーブルに含まれない場合は、 ItemNotFound エラーをスローします。

parentTable?: Word.Interfaces.TableLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

parentTableCell

段落を含むテーブルのセルを取得します。 テーブル セルに含まれない場合は、 ItemNotFound エラーをスローします。

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

parentTableCellOrNullObject

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

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

parentTableOrNullObject

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

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

rightIndent

段落の右インデント値を指定します (ポイント単位)。

rightIndent?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

shading

段落の網かけ形式を参照する ShadingUniversal オブジェクトを返します。

shading?: Word.Interfaces.ShadingUniversalLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

spaceAfter

段落の後の間隔を指定します (ポイント単位)。

spaceAfter?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

spaceBefore

段落の前の間隔を指定します (ポイント単位)。

spaceBefore?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

style

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

style?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

styleBuiltIn

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

styleBuiltIn?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.3

tableNestingLevel

段落のテーブルのレベルを取得します。 段落が表内にない場合は 0 を返します。

tableNestingLevel?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.3

text

段落のテキストを取得します。

text?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

uniqueLocalId

現在のセッションの段落識別子を表す文字列を取得します。 ID は、中かっこのない標準の 8-4-4-4-12 GUID 形式であり、セッションおよび共同作成者によって異なります。

uniqueLocalId?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.6