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 load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as 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.
isLastParagraph	For EACH ITEM in the collection: Indicates the paragraph is the last one inside its parent body.
isListItem	For EACH ITEM in the collection: Checks whether the paragraph is a list item.
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.
list	For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an ItemNotFound error if the paragraph isn't in a list.
listItem	For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an ItemNotFound error if the paragraph isn't part of a list.
listItemOrNullObject	For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
listOrNullObject	For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
outlineLevel	For EACH ITEM in the collection: Specifies the outline level for the paragraph.
parentBody	For EACH ITEM in the collection: Gets the parent body of 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.
parentContentControlOrNullObject	For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
parentTable	For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an ItemNotFound error if it isn't contained in a table.
parentTableCell	For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an ItemNotFound error if it isn't contained in a table cell.
parentTableCellOrNullObject	For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
parentTableOrNullObject	For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
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.
styleBuiltIn	For EACH ITEM in the collection: Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.
tableNestingLevel	For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table.
text	For EACH ITEM in the collection: Gets the text of the paragraph.
uniqueLocalId	For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.

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

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 ]

isLastParagraph

For EACH ITEM in the collection: Indicates the paragraph is the last one inside its parent body.

isLastParagraph?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

isListItem

For EACH ITEM in the collection: Checks whether the paragraph is a list item.

isListItem?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

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 ]

list

For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an ItemNotFound error if the paragraph isn't in a list.

list?: Word.Interfaces.ListLoadOptions;

Property Value

Word.Interfaces.ListLoadOptions

Remarks

[ API set: WordApi 1.3 ]

listItem

For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an ItemNotFound error if the paragraph isn't part of a list.

listItem?: Word.Interfaces.ListItemLoadOptions;

Property Value

Word.Interfaces.ListItemLoadOptions

Remarks

[ API set: WordApi 1.3 ]

listItemOrNullObject

For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions;

Property Value

Word.Interfaces.ListItemLoadOptions

Remarks

[ API set: WordApi 1.3 ]

listOrNullObject

For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

listOrNullObject?: Word.Interfaces.ListLoadOptions;

Property Value

Word.Interfaces.ListLoadOptions

Remarks

[ API set: WordApi 1.3 ]

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 ]

parentBody

For EACH ITEM in the collection: Gets the parent body of the paragraph.

parentBody?: Word.Interfaces.BodyLoadOptions;

Property Value

Word.Interfaces.BodyLoadOptions

Remarks

[ API set: WordApi 1.3 ]

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 ]

parentContentControlOrNullObject

For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

Property Value

Word.Interfaces.ContentControlLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTable

For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an ItemNotFound error if it isn't contained in a table.

parentTable?: Word.Interfaces.TableLoadOptions;

Property Value

Word.Interfaces.TableLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTableCell

For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an ItemNotFound error if it isn't contained in a table cell.

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Property Value

Word.Interfaces.TableCellLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTableCellOrNullObject

For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Property Value

Word.Interfaces.TableCellLoadOptions

Remarks

[ API set: WordApi 1.3 ]

parentTableOrNullObject

For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Property Value

Word.Interfaces.TableLoadOptions

Remarks

[ API set: WordApi 1.3 ]

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 ]

styleBuiltIn

For EACH ITEM in the collection: Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property.

styleBuiltIn?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

tableNestingLevel

For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table.

tableNestingLevel?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.3 ]

text

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

text?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.1 ]

uniqueLocalId

For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors.

uniqueLocalId?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.6 ]