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 |
| 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. |
| 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. |
| outline |
Specifies the outline level for the paragraph. |
| parent |
Gets the content control that contains the paragraph. Throws an |
| 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. |
| 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
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
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
outlineLevel
Specifies the outline level for the paragraph.
outlineLevel?: boolean;
Property Value
boolean
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
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
text
Gets the text of the paragraph.
text?: boolean;
Property Value
boolean