PowerPoint.SlideLayoutBackground class
Represents the background of a slide layout.
- Extends
Remarks
Properties
| are |
Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| fill | Returns the fill formatting of the background. |
| is |
Specifies if the slide layout background follows the slide master background. |
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 |
| reset() | Resets the fill formatting of the slide layout background. |
| toJSON() | Overrides the JavaScript |
Property Details
areBackgroundGraphicsHidden
Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
areBackgroundGraphicsHidden: boolean;Property Value
boolean
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
fill
Returns the fill formatting of the background.
readonly fill: PowerPoint.SlideBackgroundFill;Property Value
Remarks
isMasterBackgroundFollowed
Specifies if the slide layout background follows the slide master background.
isMasterBackgroundFollowed: 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?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions): PowerPoint.SlideLayoutBackground;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.SlideLayoutBackground;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.SlideLayoutBackground;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
reset()
Resets the fill formatting of the slide layout background.
reset(): void;Returns
void
Remarks
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.SlideLayoutBackground object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.SlideLayoutBackgroundData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): PowerPoint.Interfaces.SlideLayoutBackgroundData;