PowerPoint.SlideCollection class

Package:

powerpoint

Represents the collection of slides in the presentation.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi 1.2 ]

Examples

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

const chosenMaster = $("#master-id").val() as string;
const chosenLayout = $("#layout-id").val() as string;

await PowerPoint.run(async function(context) {
  // Create a new slide using an existing master slide and layout.
  const newSlideOptions: PowerPoint.AddSlideOptions = {
    slideMasterId: chosenMaster, /* An ID from `Presentation.slideMasters`. */
    layoutId: chosenLayout /* An ID from `SlideMaster.layouts`. */
  };
  context.presentation.slides.add(newSlideOptions);
  await context.sync();
});

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

add(options)	Adds a new slide at the end of the collection.
getCount()	Gets the number of slides in the collection.
getItem(key)	Gets a slide using its unique ID.
getItemAt(index)	Gets a slide using its zero-based index in the collection. Slides are stored in the same order as they are shown in the presentation.
getItemOrNullObject(id)	Gets a slide using its unique ID. If such a slide 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 is passed to it.) Whereas the original PowerPoint.SlideCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.SlideCollectionData) 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.Slide[];

Property Value

PowerPoint.Slide[]

Method Details

add(options)

Adds a new slide at the end of the collection.

add(options?: PowerPoint.AddSlideOptions): void;

Parameters

options

PowerPoint.AddSlideOptions

The options that define the theme of the new slide.

Returns

void

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

const chosenMaster = $("#master-id").val() as string;
const chosenLayout = $("#layout-id").val() as string;

await PowerPoint.run(async function(context) {
  // Create a new slide using an existing master slide and layout.
  const newSlideOptions: PowerPoint.AddSlideOptions = {
    slideMasterId: chosenMaster, /* An ID from `Presentation.slideMasters`. */
    layoutId: chosenLayout /* An ID from `SlideMaster.layouts`. */
  };
  context.presentation.slides.add(newSlideOptions);
  await context.sync();
});

getCount()

Gets the number of slides in the collection.

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

The number of slides in the collection.

Remarks

[ API set: PowerPointApi 1.2 ]

getItem(key)

Gets a slide using its unique ID.

getItem(key: string): PowerPoint.Slide;

Parameters

key

string

The ID of the slide.

Returns

PowerPoint.Slide

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

Remarks

[ API set: PowerPointApi 1.2 ]

getItemAt(index)

Gets a slide using its zero-based index in the collection. Slides are stored in the same order as they are shown in the presentation.

getItemAt(index: number): PowerPoint.Slide;

Parameters

index

number

The index of the slide in the collection.

Returns

PowerPoint.Slide

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

Remarks

[ API set: PowerPointApi 1.2 ]

Examples

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

// Selects slides 2, 4, and 5.
await PowerPoint.run(async (context) => {
  context.presentation.load("slides");
  await context.sync();
  const slide2: PowerPoint.Slide = context.presentation.slides.getItemAt(1);
  const slide4: PowerPoint.Slide = context.presentation.slides.getItemAt(3);
  const slide5: PowerPoint.Slide = context.presentation.slides.getItemAt(4);
  slide2.load("id");
  slide4.load("id");
  slide5.load("id");
  try {
    await context.sync();
  } catch (error) {
    console.warn("This action requires at least 5 slides in the presentation.");
    return;
  }
  await context.sync();
  context.presentation.setSelectedSlides([slide2.id, slide4.id, slide5.id]);
  await context.sync();
});

getItemOrNullObject(id)

Gets a slide using its unique ID. If such a slide 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.Slide;

Parameters

id

string

The ID of the slide.

Returns

PowerPoint.Slide

The slide with the unique ID.

Remarks

[ API set: PowerPointApi 1.2 ]

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

Parameters

options

PowerPoint.Interfaces.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.SlideCollection

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

Parameters

propertyNames

string | string[]

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

Returns

PowerPoint.SlideCollection

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

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

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

toJSON(): PowerPoint.Interfaces.SlideCollectionData;

Returns

PowerPoint.Interfaces.SlideCollectionData