Word.Interfaces.ParagraphLoadOptions interface

Package:

word

Represents a single paragraph in a selection, range, content control, or document body.

Remarks

[ API set: WordApi 1.1 ]

Properties

$all	Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
alignment	Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
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.
font	Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
leftIndent	Specifies the left indent value, in points, for the paragraph.
lineSpacing	Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12.
lineUnitAfter	Specifies the amount of spacing, in grid lines, after the paragraph.
lineUnitBefore	Specifies the amount of spacing, in grid lines, before the paragraph.
outlineLevel	Specifies the outline level for the paragraph.
parentContentControl	Gets the content control that contains the paragraph. Throws an ItemNotFound error if there isn't a parent content control.
rightIndent	Specifies the right indent value, in points, for the paragraph.
spaceAfter	Specifies the spacing, in points, after the paragraph.
spaceBefore	Specifies the spacing, in points, before the paragraph.
style	Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.
text	Gets the text of the paragraph.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

alignment

Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.

alignment?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

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?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

font

Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.

font?: Word.Interfaces.FontLoadOptions;

Property Value

Word.Interfaces.FontLoadOptions

Remarks

[ API set: WordApi 1.1 ]

leftIndent

Specifies the left indent value, in points, for the paragraph.

leftIndent?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

lineSpacing

Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12.

lineSpacing?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

lineUnitAfter

Specifies the amount of spacing, in grid lines, after the paragraph.

lineUnitAfter?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

lineUnitBefore

Specifies the amount of spacing, in grid lines, before the paragraph.

lineUnitBefore?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

outlineLevel

Specifies the outline level for the paragraph.

outlineLevel?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

parentContentControl

Gets the content control that contains the paragraph. Throws an ItemNotFound error if there isn't a parent content control.

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Property Value

Word.Interfaces.ContentControlLoadOptions

Remarks

[ API set: WordApi 1.1 ]

rightIndent

Specifies the right indent value, in points, for the paragraph.

rightIndent?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

spaceAfter

Specifies the spacing, in points, after the paragraph.

spaceAfter?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

spaceBefore

Specifies the spacing, in points, before the paragraph.

spaceBefore?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

style

Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property.

style?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

text

Gets the text of the paragraph.

text?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]