Edit

Share via

Word.Interfaces.ParagraphFormatUpdateData interface

  • Reference
Package:
word

An interface for updating data on the ParagraphFormat object, for use in paragraphFormat.set({ ... }).

Properties

alignment

Specifies the alignment for the specified paragraphs.
firstLineIndent

Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent.
keepTogether

Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document.
keepWithNext

Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document.
leftIndent

Specifies the left indent.
lineSpacing

Specifies the line spacing (in points) for the specified paragraphs.
lineUnitAfter

Specifies the amount of spacing (in gridlines) after the specified paragraphs.
lineUnitBefore

Specifies the amount of spacing (in gridlines) before the specified paragraphs.
mirrorIndents

Specifies whether left and right indents are the same width.
outlineLevel

Specifies the outline level for the specified paragraphs.
rightIndent

Specifies the right indent (in points) for the specified paragraphs.
spaceAfter

Specifies the amount of spacing (in points) after the specified paragraph or text column.
spaceBefore

Specifies the spacing (in points) before the specified paragraphs.
widowControl

Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document.

Property Details

alignment

Specifies the alignment for the specified paragraphs.

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

Property Value

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

Remarks

[ API set: WordApi 1.5 ]

firstLineIndent

Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent.

firstLineIndent?: number;

Property Value

number

Remarks

[ API set: WordApi 1.5 ]

keepTogether

Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document.

keepTogether?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]

keepWithNext

Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document.

keepWithNext?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]

leftIndent

Specifies the left indent.

leftIndent?: number;

Property Value

number

Remarks

[ API set: WordApi 1.5 ]

lineSpacing

Specifies the line spacing (in points) for the specified paragraphs.

lineSpacing?: number;

Property Value

number

Remarks

[ API set: WordApi 1.5 ]

lineUnitAfter

Specifies the amount of spacing (in gridlines) after the specified paragraphs.

lineUnitAfter?: number;

Property Value

number

Remarks

[ API set: WordApi 1.5 ]

lineUnitBefore

Specifies the amount of spacing (in gridlines) before the specified paragraphs.

lineUnitBefore?: number;

Property Value

number

Remarks

[ API set: WordApi 1.5 ]

mirrorIndents

Specifies whether left and right indents are the same width.

mirrorIndents?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]

outlineLevel

Specifies the outline level for the specified paragraphs.

outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText";

Property Value

Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"

Remarks

[ API set: WordApi 1.5 ]

rightIndent

Specifies the right indent (in points) for the specified paragraphs.

rightIndent?: number;

Property Value

number

Remarks

[ API set: WordApi 1.5 ]

spaceAfter

Specifies the amount of spacing (in points) after the specified paragraph or text column.

spaceAfter?: number;

Property Value

number

Remarks

[ API set: WordApi 1.5 ]

spaceBefore

Specifies the spacing (in points) before the specified paragraphs.

spaceBefore?: number;

Property Value

number

Remarks

[ API set: WordApi 1.5 ]

widowControl

Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document.

widowControl?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.5 ]