PowerPoint.SlideMaster class

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 Slide Master of a slide.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Extends

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

id

Gets the unique ID of the Slide Master.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

layouts

Gets the collection of layouts provided by the Slide Master for slides.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

name

Gets the unique name of the Slide Master.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Methods

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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 PowerPoint.SlideMaster object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.SlideMasterData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

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.

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

id

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.

Gets the unique ID of the Slide Master.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

readonly id: string;

Property Value

string

layouts

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.

Gets the collection of layouts provided by the Slide Master for slides.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

readonly layouts: PowerPoint.SlideLayoutCollection;

Property Value

name

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.

Gets the unique name of the Slide Master.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

readonly name: string;

Property Value

string

Method Details

load(options)

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.

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.SlideMasterLoadOptions): PowerPoint.SlideMaster;

Parameters

options
PowerPoint.Interfaces.SlideMasterLoadOptions

Provides options for which properties of the object to load.

Returns

load(propertyNames)

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.

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.SlideMaster;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

load(propertyNamesAndPaths)

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.

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.SlideMaster;

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()

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.

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 PowerPoint.SlideMaster object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.SlideMasterData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): PowerPoint.Interfaces.SlideMasterData;

Returns