PowerPoint.Presentation class

Package:

powerpoint

Extends

OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi 1.0 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
slideMasters	Returns the collection of SlideMaster objects that are in the presentation.
slides	Returns an ordered collection of slides in the presentation.
tags	Returns a collection of tags attached to the presentation.
title

Methods

insertSlidesFromBase64(base64File, options)	Inserts the specified slides from a presentation into the current presentation.
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.Presentation object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.PresentationData) 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

slideMasters

Returns the collection of SlideMaster objects that are in the presentation.

readonly slideMasters: PowerPoint.SlideMasterCollection;

Property Value

PowerPoint.SlideMasterCollection

Remarks

[ API set: PowerPointApi 1.3 ]

slides

Returns an ordered collection of slides in the presentation.

readonly slides: PowerPoint.SlideCollection;

Property Value

PowerPoint.SlideCollection

Remarks

[ API set: PowerPointApi 1.2 ]

tags

Returns a collection of tags attached to the presentation.

readonly tags: PowerPoint.TagCollection;

Property Value

PowerPoint.TagCollection

Remarks

[ API set: PowerPointApi 1.3 ]

title

readonly title: string;

Property Value

string

Method Details

insertSlidesFromBase64(base64File, options)

Inserts the specified slides from a presentation into the current presentation.

insertSlidesFromBase64(base64File: string, options?: PowerPoint.InsertSlideOptions): void;

Parameters

base64File

string

The base64-encoded string representing the source presentation file.

options

PowerPoint.InsertSlideOptions

The options that define which slides will be inserted, where the new slides will go, and which presentation's formatting will be used.

Returns

void

Remarks

[ API set: PowerPointApi 1.2 ]

Examples

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

await PowerPoint.run(async function(context) {
    const selectedSlideID = await getSelectedSlideID();

    context.presentation.insertSlidesFromBase64(chosenFileBase64, {
        formatting: PowerPoint.InsertSlideFormatting.useDestinationTheme,
        targetSlideId: selectedSlideID + "#"
    });
    await context.sync();
});

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.PresentationLoadOptions): PowerPoint.Presentation;

Parameters

options

PowerPoint.Interfaces.PresentationLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.Presentation

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

Parameters

propertyNames

string | string[]

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

Returns

PowerPoint.Presentation

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

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

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.Presentation object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.PresentationData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): PowerPoint.Interfaces.PresentationData;

Returns

PowerPoint.Interfaces.PresentationData