PowerPoint.ParagraphFormat class
Represents the paragraph formatting properties of a text that is attached to the PowerPoint.TextRange.
- Extends
Remarks
Properties
| bullet |
Represents the bullet format of the paragraph. See PowerPoint.BulletFormat for details. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| horizontal |
Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See PowerPoint.ParagraphHorizontalAlignment for details. |
| indent |
Represents the indent level of the paragraph. |
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 |
| toJSON() | Overrides the JavaScript |
Property Details
bulletFormat
Represents the bullet format of the paragraph. See PowerPoint.BulletFormat for details.
readonly bulletFormat: PowerPoint.BulletFormat;Property Value
Remarks
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
horizontalAlignment
Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See PowerPoint.ParagraphHorizontalAlignment for details.
horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;Property Value
PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null
Remarks
indentLevel
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Represents the indent level of the paragraph.
indentLevel: number;Property Value
number
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?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.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[]): PowerPoint.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;
}): PowerPoint.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
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's passed to it.) Whereas the original PowerPoint.ParagraphFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.ParagraphFormatData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): PowerPoint.Interfaces.ParagraphFormatData;