Word.Interfaces.ParagraphData interface

paragraph.toJSON() の呼び出しによって返されるデータを記述するインターフェイス。

注釈

使用元

プロパティ

alignment

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

borders

段落のすべての境界線を表す BorderUniversalCollection オブジェクトを返します。

fields

段落内のフィールドのコレクションを取得します。

firstLineIndent

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

font

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

inlinePictures

段落内の InlinePicture オブジェクトのコレクションを取得します。 コレクションには、フローティング イメージは含まれません。

isLastParagraph

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

isListItem

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

leftIndent

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

lineSpacing

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

lineUnitAfter

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

lineUnitBefore

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

listItem

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

listItemOrNullObject

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

outlineLevel

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

rightIndent

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

shading

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

shapes

インライン図形とフローティング図形の両方を含む、段落に固定されている Shape オブジェクトのコレクションを取得します。 現時点では、テキスト ボックス、幾何学的図形、グループ、画像、キャンバスの図形のみがサポートされています。

spaceAfter

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

spaceBefore

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

style

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

styleBuiltIn

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

tableNestingLevel

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

text

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

uniqueLocalId

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

プロパティの詳細

alignment

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

alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

プロパティ値

Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

注釈

API セット: WordApi 1.1

borders

段落のすべての境界線を表す BorderUniversalCollection オブジェクトを返します。

borders?: Word.Interfaces.BorderUniversalData[];

プロパティ値

注釈

API セット: WordApiDesktop 1.3

fields

段落内のフィールドのコレクションを取得します。

fields?: Word.Interfaces.FieldData[];

プロパティ値

注釈

API セット: WordApi 1.4

firstLineIndent

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

firstLineIndent?: number;

プロパティ値

number

注釈

API セット: WordApi 1.1

font

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

font?: Word.Interfaces.FontData;

プロパティ値

注釈

API セット: WordApi 1.1

inlinePictures

段落内の InlinePicture オブジェクトのコレクションを取得します。 コレクションには、フローティング イメージは含まれません。

inlinePictures?: Word.Interfaces.InlinePictureData[];

プロパティ値

注釈

API セット: WordApi 1.1

isLastParagraph

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

isLastParagraph?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.3

isListItem

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

isListItem?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.3

leftIndent

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

leftIndent?: number;

プロパティ値

number

注釈

API セット: WordApi 1.1

lineSpacing

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

lineSpacing?: number;

プロパティ値

number

注釈

API セット: WordApi 1.1

lineUnitAfter

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

lineUnitAfter?: number;

プロパティ値

number

注釈

API セット: WordApi 1.1

lineUnitBefore

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

lineUnitBefore?: number;

プロパティ値

number

注釈

API セット: WordApi 1.1

listItem

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

listItem?: Word.Interfaces.ListItemData;

プロパティ値

注釈

API セット: WordApi 1.3

listItemOrNullObject

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

listItemOrNullObject?: Word.Interfaces.ListItemData;

プロパティ値

注釈

API セット: WordApi 1.3

outlineLevel

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

outlineLevel?: number;

プロパティ値

number

注釈

API セット: WordApi 1.1

rightIndent

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

rightIndent?: number;

プロパティ値

number

注釈

API セット: WordApi 1.1

shading

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

shading?: Word.Interfaces.ShadingUniversalData;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

shapes

インライン図形とフローティング図形の両方を含む、段落に固定されている Shape オブジェクトのコレクションを取得します。 現時点では、テキスト ボックス、幾何学的図形、グループ、画像、キャンバスの図形のみがサポートされています。

shapes?: Word.Interfaces.ShapeData[];

プロパティ値

注釈

API セット: WordApiDesktop 1.2

重要: 時間の経過とともに、追加の種類の図形がサポートされる場合があることに注意してください。 そのため、アドインでは特定の種類の図形を要求および処理する必要があります。

spaceAfter

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

spaceAfter?: number;

プロパティ値

number

注釈

API セット: WordApi 1.1

spaceBefore

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

spaceBefore?: number;

プロパティ値

number

注釈

API セット: WordApi 1.1

style

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

style?: string;

プロパティ値

string

注釈

API セット: WordApi 1.1

styleBuiltIn

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

styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

プロパティ値

Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"

注釈

API セット: WordApi 1.3

tableNestingLevel

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

tableNestingLevel?: number;

プロパティ値

number

注釈

API セット: WordApi 1.3

text

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

text?: string;

プロパティ値

string

注釈

API セット: WordApi 1.1

uniqueLocalId

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

uniqueLocalId?: string;

プロパティ値

string

注釈

API セット: WordApi 1.6