Word.Interfaces.ParagraphCollectionLoadOptions interface

Package:

word

Contains a collection of Word.Paragraph objects.

Remarks

[ API set: WordApi 1.1 ]

Properties

$all	Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
alignment	For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
firstLineIndent	For EACH ITEM in the collection: 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	For EACH ITEM in the collection: Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties.
leftIndent	For EACH ITEM in the collection: Specifies the left indent value, in points, for the paragraph.
lineSpacing	For EACH ITEM in the collection: Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12.
lineUnitAfter	For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, after the paragraph.
lineUnitBefore	For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, before the paragraph.
outlineLevel	For EACH ITEM in the collection: Specifies the outline level for the paragraph.
parentContentControl	For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an ItemNotFound error if there isn't a parent content control.
rightIndent	For EACH ITEM in the collection: Specifies the right indent value, in points, for the paragraph.
spaceAfter	For EACH ITEM in the collection: Specifies the spacing, in points, after the paragraph.
spaceBefore	For EACH ITEM in the collection: Specifies the spacing, in points, before the paragraph.
style	For EACH ITEM in the collection: 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	For EACH ITEM in the collection: Gets the text of the paragraph.

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

alignment

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies the left indent value, in points, for the paragraph.

leftIndent?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

lineSpacing

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, after the paragraph.

lineUnitAfter?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

lineUnitBefore

For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, before the paragraph.

lineUnitBefore?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

outlineLevel

For EACH ITEM in the collection: Specifies the outline level for the paragraph.

outlineLevel?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

parentContentControl

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies the right indent value, in points, for the paragraph.

rightIndent?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

spaceAfter

For EACH ITEM in the collection: Specifies the spacing, in points, after the paragraph.

spaceAfter?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

spaceBefore

For EACH ITEM in the collection: Specifies the spacing, in points, before the paragraph.

spaceBefore?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

style

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Gets the text of the paragraph.

text?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]