PowerPoint.SlideMaster class

Package:

powerpoint

Represents the Slide Master of a slide.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi 1.3 ]

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.
layouts	Gets the collection of layouts provided by the Slide Master for slides.
name	Gets the unique name of the Slide Master.
shapes	Returns a collection of shapes in the Slide Master.

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

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

PowerPoint.RequestContext

id

Gets the unique ID of the Slide Master.

readonly id: string;

Property Value

string

Remarks

[ API set: PowerPointApi 1.3 ]

layouts

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

readonly layouts: PowerPoint.SlideLayoutCollection;

Property Value

PowerPoint.SlideLayoutCollection

Remarks

[ API set: PowerPointApi 1.3 ]

name

Gets the unique name of the Slide Master.

readonly name: string;

Property Value

string

Remarks

[ API set: PowerPointApi 1.3 ]

shapes

Returns a collection of shapes in the Slide Master.

readonly shapes: PowerPoint.ShapeCollection;

Property Value

PowerPoint.ShapeCollection

Remarks

[ API set: PowerPointApi 1.3 ]

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

Parameters

options

PowerPoint.Interfaces.SlideMasterLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.SlideMaster

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

Parameters

propertyNames

string | string[]

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

Returns

PowerPoint.SlideMaster

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

PowerPoint.SlideMaster

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.

toJSON(): PowerPoint.Interfaces.SlideMasterData;

Returns

PowerPoint.Interfaces.SlideMasterData