Word.Interfaces.ParagraphLoadOptions interface
Represents a single paragraph in a selection, range, content control, or document body.
Remarks
Properties
| $all | Specifying |
| alignment | Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. |
| first |
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. |
| is |
Indicates the paragraph is the last one inside its parent body. |
| is |
Checks whether the paragraph is a list item. |
| left |
Specifies the left indent value, in points, for the paragraph. |
| line |
Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. |
| line |
Specifies the amount of spacing, in grid lines, after the paragraph. |
| line |
Specifies the amount of spacing, in grid lines, before the paragraph. |
| list | Gets the List to which this paragraph belongs. Throws an |
| list |
Gets the ListItem for the paragraph. Throws an |
| list |
Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its |
| list |
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 |
| outline |
Specifies the outline level for the paragraph. |
| parent |
Gets the parent body of the paragraph. |
| parent |
Gets the content control that contains the paragraph. Throws an |
| parent |
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 |
| parent |
Gets the table that contains the paragraph. Throws an |
| parent |
Gets the table cell that contains the paragraph. Throws an |
| parent |
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 |
| parent |
Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return an object with its |
| right |
Specifies the right indent value, in points, for the paragraph. |
| space |
Specifies the spacing, in points, after the paragraph. |
| space |
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. |
| style |
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. |
| table |
Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. |
| text | Gets the text of the paragraph. |
| unique |
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 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
Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
alignment?: boolean;Property Value
boolean
Remarks
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
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
Remarks
isLastParagraph
Indicates the paragraph is the last one inside its parent body.
isLastParagraph?: boolean;Property Value
boolean
Remarks
isListItem
Checks whether the paragraph is a list item.
isListItem?: boolean;Property Value
boolean
Remarks
leftIndent
Specifies the left indent value, in points, for the paragraph.
leftIndent?: boolean;Property Value
boolean
Remarks
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
lineUnitAfter
Specifies the amount of spacing, in grid lines, after the paragraph.
lineUnitAfter?: boolean;Property Value
boolean
Remarks
lineUnitBefore
Specifies the amount of spacing, in grid lines, before the paragraph.
lineUnitBefore?: boolean;Property Value
boolean
Remarks
list
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
Remarks
listItem
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
Remarks
listItemOrNullObject
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
Remarks
listOrNullObject
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
Remarks
outlineLevel
Specifies the outline level for the paragraph.
outlineLevel?: boolean;Property Value
boolean
Remarks
parentBody
Gets the parent body of the paragraph.
parentBody?: Word.Interfaces.BodyLoadOptions;Property Value
Remarks
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
Remarks
parentContentControlOrNullObject
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
Remarks
parentTable
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
Remarks
parentTableCell
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
Remarks
parentTableCellOrNullObject
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
Remarks
parentTableOrNullObject
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
Remarks
rightIndent
Specifies the right indent value, in points, for the paragraph.
rightIndent?: boolean;Property Value
boolean
Remarks
spaceAfter
Specifies the spacing, in points, after the paragraph.
spaceAfter?: boolean;Property Value
boolean
Remarks
spaceBefore
Specifies the spacing, in points, before the paragraph.
spaceBefore?: boolean;Property Value
boolean
Remarks
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
styleBuiltIn
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
tableNestingLevel
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
text
Gets the text of the paragraph.
text?: boolean;Property Value
boolean
Remarks
uniqueLocalId
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
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for