PowerPoint.SlideLayoutCollection class

Package:

powerpoint

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

Extends

OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi 1.3 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml

await PowerPoint.run(async function(context) {
  // Load information about all the slide masters and associated layouts.
  const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
  await context.sync();

  // Log the name and ID of each slide master.
  for (let i = 0; i < slideMasters.items.length; i++) {
    console.log("Master name: " + slideMasters.items[i].name);
    console.log("Master ID: " + slideMasters.items[i].id);

    // Log the name and ID of each slide layout in the slide master.
    const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
    for (let j = 0; j < layoutsInMaster.items.length; j++) {
      console.log("    Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
    }
  }
});

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.
getItem(key)	Gets a layout using its unique ID.
getItemAt(index)	Gets a layout using its zero-based index in the collection.
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.
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's 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

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

items

Gets the loaded child items in this collection.

readonly items: PowerPoint.SlideLayout[];

Property Value

PowerPoint.SlideLayout[]

Method Details

getCount()

Gets the number of layouts in the collection.

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

The number of layouts in the collection.

Remarks

[ API set: PowerPointApi 1.3 ]

getItem(key)

Gets a layout using its unique ID.

getItem(key: string): PowerPoint.SlideLayout;

Parameters

key

string

The ID of the layout.

Returns

PowerPoint.SlideLayout

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

Remarks

[ API set: PowerPointApi 1.3 ]

getItemAt(index)

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

getItemAt(index: number): PowerPoint.SlideLayout;

Parameters

index

number

The index of the layout in the collection.

Returns

PowerPoint.SlideLayout

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

Remarks

[ API set: PowerPointApi 1.3 ]

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.

getItemOrNullObject(id: string): PowerPoint.SlideLayout;

Parameters

id

string

The ID of the layout.

Returns

PowerPoint.SlideLayout

The layout with the unique ID.

Remarks

[ API set: PowerPointApi 1.3 ]

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

PowerPoint.SlideLayoutCollection

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

Parameters

propertyNames

string | string[]

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

Returns

PowerPoint.SlideLayoutCollection

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml

await PowerPoint.run(async function(context) {
  // Load information about all the slide masters and associated layouts.
  const slideMasters: PowerPoint.SlideMasterCollection = context.presentation.slideMasters.load("id, name, layouts/items/name, layouts/items/id");
  await context.sync();

  // Log the name and ID of each slide master.
  for (let i = 0; i < slideMasters.items.length; i++) {
    console.log("Master name: " + slideMasters.items[i].name);
    console.log("Master ID: " + slideMasters.items[i].id);

    // Log the name and ID of each slide layout in the slide master.
    const layoutsInMaster: PowerPoint.SlideLayoutCollection = slideMasters.items[i].layouts;
    for (let j = 0; j < layoutsInMaster.items.length; j++) {
      console.log("    Layout name: " + layoutsInMaster.items[j].name + " Layout ID: " + layoutsInMaster.items[j].id);
    }
  }
});

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?: 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

PowerPoint.SlideLayoutCollection

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

PowerPoint.Interfaces.SlideLayoutCollectionData