Ask Learn
Preview
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign inThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Represents the collection of slides in the presentation.
[ API set: PowerPointApi 1.2 ]
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
const chosenMaster = (document.getElementById("master-id") as HTMLInputElement).value;
const chosenLayout = (document.getElementById("layout-id") as HTMLInputElement).value;
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();
});
add(options) | Adds a new slide at the end of the collection. |
get |
Gets the number of slides in the collection. |
get |
Gets a slide using its unique ID. |
get |
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. |
get |
Gets a slide using its unique ID. If such a slide doesn't exist, an object with an |
load(options) | Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
toJSON() | Overrides the JavaScript |
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;
Gets the loaded child items in this collection.
readonly items: PowerPoint.Slide[];
Adds a new slide at the end of the collection.
add(options?: PowerPoint.AddSlideOptions): void;
The options that define the theme of the new slide.
void
[ API set: PowerPointApi 1.3 ]
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/add-slides.yaml
const chosenMaster = (document.getElementById("master-id") as HTMLInputElement).value;
const chosenLayout = (document.getElementById("layout-id") as HTMLInputElement).value;
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();
});
Gets the number of slides in the collection.
getCount(): OfficeExtension.ClientResult<number>;
OfficeExtension.ClientResult<number>
The number of slides in the collection.
Gets a slide using its unique ID.
getItem(key: string): PowerPoint.Slide;
string
The ID of the slide.
The slide with the unique ID. If such a slide doesn't exist, an error is thrown.
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;
number
The index of the slide in the collection.
The slide at the given index. An error is thrown if index is out of range.
[ API set: PowerPointApi 1.2 ]
// 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();
});
Gets a slide using its unique ID. If such a slide doesn't 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;
string
The ID of the slide.
The slide with the unique ID.
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;
PowerPoint.Interfaces.SlideCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Provides options for which properties of the object to load.
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;
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
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;
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.
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.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;
Office Add-ins feedback
Office Add-ins is an open source project. Select a link to provide feedback:
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign in