PowerPoint.SlideLayoutCollection 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 collection of layouts provided by the Slide Master for slides.

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

items

Gets the loaded child items in this collection.

Methods

getCount()

Gets the number of layouts in the collection.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

getItem(key)

Gets a layout using its unique ID.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

getItemAt(index)

Gets a layout using its zero-based index in the collection.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

getItemOrNullObject(id)

Gets a layout using its unique ID. If such a layout does not exist, an object with an isNullObject property set to true is returned. For further information, see *OrNullObject methods and properties.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

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.SlideLayoutCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.SlideLayoutCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

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

items

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 loaded child items in this collection.

readonly items: PowerPoint.SlideLayout[];

Property Value

Method Details

getCount()

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 number of layouts in the collection.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

getCount(): OfficeExtension.ClientResult<number>;

Returns

The number of layouts in the collection.

getItem(key)

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 a layout using its unique ID.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

getItem(key: string): PowerPoint.SlideLayout;

Parameters

key

string

The ID of the layout.

Returns

The layout with the unique ID. If such a layout does not exist, an error is thrown.

getItemAt(index)

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 a layout using its zero-based index in the collection.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

getItemAt(index: number): PowerPoint.SlideLayout;

Parameters

index

number

The index of the layout in the collection.

Returns

The layout at the given index. An error is thrown if index is out of range.

getItemOrNullObject(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 a layout using its unique ID. If such a layout does not exist, an object with an isNullObject property set to true is returned. For further information, see *OrNullObject methods and properties.

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

getItemOrNullObject(id: string): PowerPoint.SlideLayout;

Parameters

id

string

The ID of the layout.

Returns

The layout with the unique ID.

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.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;

Parameters

options

PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

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?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection;

Parameters

propertyNamesAndPaths
OfficeExtension.LoadOption

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.SlideLayoutCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.SlideLayoutCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;

Returns