Word.ParagraphFormat class
Represents a style of paragraph in a document.
- Extends
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml
// Sets certain aspects of the specified style's paragraph format e.g., the left indent size and the alignment.
await Word.run(async (context) => {
const styleName = $("#style-name").val() as string;
if (styleName == "") {
console.warn("Enter a style name to update its paragraph format.");
return;
}
const style = context.document.getStyles().getByNameOrNullObject(styleName);
style.load();
await context.sync();
if (style.isNullObject) {
console.warn(`There's no existing style with the name '${styleName}'.`);
} else {
style.paragraphFormat.leftIndent = 30;
style.paragraphFormat.alignment = Word.Alignment.centered;
console.log(`Successfully the paragraph format of the '${styleName}' style.`);
}
});
Properties
| alignment | Specifies the alignment for the specified paragraphs. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| 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. |
| keep |
Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. |
| keep |
Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. |
| left |
Specifies the left indent. |
| line |
Specifies the line spacing (in points) for the specified paragraphs. |
| line |
Specifies the amount of spacing (in gridlines) after the specified paragraphs. |
| line |
Specifies the amount of spacing (in gridlines) before the specified paragraphs. |
| mirror |
Specifies whether left and right indents are the same width. |
| outline |
Specifies the outline level for the specified paragraphs. |
| right |
Specifies the right indent (in points) for the specified paragraphs. |
| space |
Specifies the amount of spacing (in points) after the specified paragraph or text column. |
| space |
Specifies the spacing (in points) before the specified paragraphs. |
| widow |
Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. |
Methods
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
Property Details
alignment
Specifies the alignment for the specified paragraphs.
alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";Property Value
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml
// Sets certain aspects of the specified style's paragraph format e.g., the left indent size and the alignment.
await Word.run(async (context) => {
const styleName = $("#style-name").val() as string;
if (styleName == "") {
console.warn("Enter a style name to update its paragraph format.");
return;
}
const style = context.document.getStyles().getByNameOrNullObject(styleName);
style.load();
await context.sync();
if (style.isNullObject) {
console.warn(`There's no existing style with the name '${styleName}'.`);
} else {
style.paragraphFormat.leftIndent = 30;
style.paragraphFormat.alignment = Word.Alignment.centered;
console.log(`Successfully the paragraph format of the '${styleName}' style.`);
}
});
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
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: number;Property Value
number
Remarks
keepTogether
Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document.
keepTogether: boolean;Property Value
boolean
Remarks
keepWithNext
Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document.
keepWithNext: boolean;Property Value
boolean
Remarks
leftIndent
Specifies the left indent.
leftIndent: number;Property Value
number
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml
// Sets certain aspects of the specified style's paragraph format e.g., the left indent size and the alignment.
await Word.run(async (context) => {
const styleName = $("#style-name").val() as string;
if (styleName == "") {
console.warn("Enter a style name to update its paragraph format.");
return;
}
const style = context.document.getStyles().getByNameOrNullObject(styleName);
style.load();
await context.sync();
if (style.isNullObject) {
console.warn(`There's no existing style with the name '${styleName}'.`);
} else {
style.paragraphFormat.leftIndent = 30;
style.paragraphFormat.alignment = Word.Alignment.centered;
console.log(`Successfully the paragraph format of the '${styleName}' style.`);
}
});
lineSpacing
Specifies the line spacing (in points) for the specified paragraphs.
lineSpacing: number;Property Value
number
Remarks
lineUnitAfter
Specifies the amount of spacing (in gridlines) after the specified paragraphs.
lineUnitAfter: number;Property Value
number
Remarks
lineUnitBefore
Specifies the amount of spacing (in gridlines) before the specified paragraphs.
lineUnitBefore: number;Property Value
number
Remarks
mirrorIndents
Specifies whether left and right indents are the same width.
mirrorIndents: boolean;Property Value
boolean
Remarks
outlineLevel
Specifies the outline level for the specified paragraphs.
outlineLevel: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText";Property Value
Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"
Remarks
rightIndent
Specifies the right indent (in points) for the specified paragraphs.
rightIndent: number;Property Value
number
Remarks
spaceAfter
Specifies the amount of spacing (in points) after the specified paragraph or text column.
spaceAfter: number;Property Value
number
Remarks
spaceBefore
Specifies the spacing (in points) before the specified paragraphs.
spaceBefore: number;Property Value
number
Remarks
widowControl
Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document.
widowControl: boolean;Property Value
boolean
Remarks
Method Details
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Word.Interfaces.ParagraphFormatLoadOptions): Word.ParagraphFormat;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Word.ParagraphFormat;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.ParagraphFormat;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.ParagraphFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Word.Interfaces.ParagraphFormatUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Word.ParagraphFormat): void;Parameters
- properties
- Word.ParagraphFormat
Returns
void
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Word.ParagraphFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.ParagraphFormatData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.ParagraphFormatData;Returns
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
track(): Word.ParagraphFormat;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.
untrack(): Word.ParagraphFormat;Returns
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