powerpoint package

Classes

PowerPoint.Application
PowerPoint.Presentation
PowerPoint.RequestContext	The RequestContext object facilitates requests to the PowerPoint application. Since the Office add-in and the PowerPoint application run in two different processes, the request context is required to get access to the PowerPoint object model from the add-in.
PowerPoint.Shape	Represents a single shape in the slide.
PowerPoint.ShapeCollection	Represents the collection of shapes.
PowerPoint.Slide	Represents a single slide of a presentation.
PowerPoint.SlideCollection	Represents the collection of slides in the presentation.
PowerPoint.SlideLayout	Represents the layout of a slide.
PowerPoint.SlideLayoutCollection	Represents the collection of layouts provided by the Slide Master for slides.
PowerPoint.SlideMaster	Represents the Slide Master of a slide.
PowerPoint.SlideMasterCollection	Represents the collection of Slide Masters in the presentation.
PowerPoint.Tag	Represents a single tag in the slide.
PowerPoint.TagCollection	Represents the collection of tags.

Interfaces

PowerPoint.AddSlideOptions	Represents the available options when adding a new slide.
PowerPoint.InsertSlideOptions	Represents the available options when inserting slides.
PowerPoint.Interfaces.BulletFormatData	An interface describing the data returned by calling bulletFormat.toJSON().
PowerPoint.Interfaces.BulletFormatUpdateData	An interface for updating data on the BulletFormat object, for use in bulletFormat.set({ ... }).
PowerPoint.Interfaces.CollectionLoadOptions	Provides ways to load properties of only a subset of members of a collection.
PowerPoint.Interfaces.HyperlinkCollectionData	An interface describing the data returned by calling hyperlinkCollection.toJSON().
PowerPoint.Interfaces.HyperlinkCollectionUpdateData	An interface for updating data on the HyperlinkCollection object, for use in hyperlinkCollection.set({ ... }).
PowerPoint.Interfaces.HyperlinkData	An interface describing the data returned by calling hyperlink.toJSON().
PowerPoint.Interfaces.HyperlinkUpdateData	An interface for updating data on the Hyperlink object, for use in hyperlink.set({ ... }).
PowerPoint.Interfaces.ParagraphFormatData	An interface describing the data returned by calling paragraphFormat.toJSON().
PowerPoint.Interfaces.ParagraphFormatUpdateData	An interface for updating data on the ParagraphFormat object, for use in paragraphFormat.set({ ... }).
PowerPoint.Interfaces.PresentationData	An interface describing the data returned by calling presentation.toJSON().
PowerPoint.Interfaces.PresentationLoadOptions
PowerPoint.Interfaces.ShapeCollectionData	An interface describing the data returned by calling shapeCollection.toJSON().
PowerPoint.Interfaces.ShapeCollectionLoadOptions	Represents the collection of shapes.
PowerPoint.Interfaces.ShapeCollectionUpdateData	An interface for updating data on the ShapeCollection object, for use in shapeCollection.set({ ... }).
PowerPoint.Interfaces.ShapeData	An interface describing the data returned by calling shape.toJSON().
PowerPoint.Interfaces.ShapeFillData	An interface describing the data returned by calling shapeFill.toJSON().
PowerPoint.Interfaces.ShapeFillUpdateData	An interface for updating data on the ShapeFill object, for use in shapeFill.set({ ... }).
PowerPoint.Interfaces.ShapeFontData	An interface describing the data returned by calling shapeFont.toJSON().
PowerPoint.Interfaces.ShapeFontUpdateData	An interface for updating data on the ShapeFont object, for use in shapeFont.set({ ... }).
PowerPoint.Interfaces.ShapeLineFormatData	An interface describing the data returned by calling shapeLineFormat.toJSON().
PowerPoint.Interfaces.ShapeLineFormatUpdateData	An interface for updating data on the ShapeLineFormat object, for use in shapeLineFormat.set({ ... }).
PowerPoint.Interfaces.ShapeLoadOptions	Represents a single shape in the slide.
PowerPoint.Interfaces.ShapeScopedCollectionData	An interface describing the data returned by calling shapeScopedCollection.toJSON().
PowerPoint.Interfaces.ShapeScopedCollectionUpdateData	An interface for updating data on the ShapeScopedCollection object, for use in shapeScopedCollection.set({ ... }).
PowerPoint.Interfaces.ShapeUpdateData	An interface for updating data on the Shape object, for use in shape.set({ ... }).
PowerPoint.Interfaces.SlideCollectionData	An interface describing the data returned by calling slideCollection.toJSON().
PowerPoint.Interfaces.SlideCollectionLoadOptions	Represents the collection of slides in the presentation.
PowerPoint.Interfaces.SlideCollectionUpdateData	An interface for updating data on the SlideCollection object, for use in slideCollection.set({ ... }).
PowerPoint.Interfaces.SlideData	An interface describing the data returned by calling slide.toJSON().
PowerPoint.Interfaces.SlideLayoutCollectionData	An interface describing the data returned by calling slideLayoutCollection.toJSON().
PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions	Represents the collection of layouts provided by the Slide Master for slides.
PowerPoint.Interfaces.SlideLayoutCollectionUpdateData	An interface for updating data on the SlideLayoutCollection object, for use in slideLayoutCollection.set({ ... }).
PowerPoint.Interfaces.SlideLayoutData	An interface describing the data returned by calling slideLayout.toJSON().
PowerPoint.Interfaces.SlideLayoutLoadOptions	Represents the layout of a slide.
PowerPoint.Interfaces.SlideLoadOptions	Represents a single slide of a presentation.
PowerPoint.Interfaces.SlideMasterCollectionData	An interface describing the data returned by calling slideMasterCollection.toJSON().
PowerPoint.Interfaces.SlideMasterCollectionLoadOptions	Represents the collection of Slide Masters in the presentation.
PowerPoint.Interfaces.SlideMasterCollectionUpdateData	An interface for updating data on the SlideMasterCollection object, for use in slideMasterCollection.set({ ... }).
PowerPoint.Interfaces.SlideMasterData	An interface describing the data returned by calling slideMaster.toJSON().
PowerPoint.Interfaces.SlideMasterLoadOptions	Represents the Slide Master of a slide.
PowerPoint.Interfaces.SlideScopedCollectionData	An interface describing the data returned by calling slideScopedCollection.toJSON().
PowerPoint.Interfaces.SlideScopedCollectionUpdateData	An interface for updating data on the SlideScopedCollection object, for use in slideScopedCollection.set({ ... }).
PowerPoint.Interfaces.TagCollectionData	An interface describing the data returned by calling tagCollection.toJSON().
PowerPoint.Interfaces.TagCollectionLoadOptions	Represents the collection of tags.
PowerPoint.Interfaces.TagCollectionUpdateData	An interface for updating data on the TagCollection object, for use in tagCollection.set({ ... }).
PowerPoint.Interfaces.TagData	An interface describing the data returned by calling tag.toJSON().
PowerPoint.Interfaces.TagLoadOptions	Represents a single tag in the slide.
PowerPoint.Interfaces.TagUpdateData	An interface for updating data on the Tag object, for use in tag.set({ ... }).
PowerPoint.Interfaces.TextFrameData	An interface describing the data returned by calling textFrame.toJSON().
PowerPoint.Interfaces.TextFrameUpdateData	An interface for updating data on the TextFrame object, for use in textFrame.set({ ... }).
PowerPoint.Interfaces.TextRangeData	An interface describing the data returned by calling textRange.toJSON().
PowerPoint.Interfaces.TextRangeUpdateData	An interface for updating data on the TextRange object, for use in textRange.set({ ... }).

Enums

PowerPoint.ErrorCodes
PowerPoint.InsertSlideFormatting	Specifies the formatting options for when slides are inserted.

Functions

PowerPoint.createPresentation(base64File)	Creates and opens a new presentation. Optionally, the presentation can be pre-populated with a Base64-encoded .pptx file. [ API set: PowerPointApi 1.1 ]
PowerPoint.run(batch)	Executes a batch script that performs actions on the PowerPoint object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
PowerPoint.run(object, batch)	Executes a batch script that performs actions on the PowerPoint object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
PowerPoint.run(objects, batch)	Executes a batch script that performs actions on the PowerPoint object model, using the RequestContext of previously-created API objects.

Function Details

PowerPoint.createPresentation(base64File)

Creates and opens a new presentation. Optionally, the presentation can be pre-populated with a Base64-encoded .pptx file.

[ API set: PowerPointApi 1.1 ]

export function createPresentation(base64File?: string): Promise<void>;

Parameters

base64File

string

Optional. The Base64-encoded .pptx file. The default value is null.

Returns

Promise<void>

Examples

const myFile = <HTMLInputElement>document.getElementById("file");
const reader = new FileReader();

reader.onload = (event) => {
  // Remove the metadata before the base64-encoded string.
  const startIndex = reader.result.toString().indexOf("base64,");
  const copyBase64 = reader.result.toString().substr(startIndex + 7);

  PowerPoint.createPresentation(copyBase64);
};

// Read in the file as a data URL so we can parse the base64-encoded string.
reader.readAsDataURL(myFile.files[0]);

PowerPoint.run(batch)

Executes a batch script that performs actions on the PowerPoint object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

export function run<T>(batch: (context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>): OfficeExtension.IPromise<T>;

Parameters

batch

(context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the PowerPoint application. Since the Office add-in and the PowerPoint application run in two different processes, the RequestContext is required to get access to the PowerPoint object model from the add-in.

Returns

OfficeExtension.IPromise<T>

PowerPoint.run(object, batch)

Executes a batch script that performs actions on the PowerPoint object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

export function run<T>(object: OfficeExtension.ClientObject, batch: (context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>): OfficeExtension.IPromise<T>;

Parameters

object

OfficeExtension.ClientObject

A previously-created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()".

batch

(context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the PowerPoint application. Since the Office add-in and the PowerPoint application run in two different processes, the RequestContext is required to get access to the PowerPoint object model from the add-in.

Returns

OfficeExtension.IPromise<T>

PowerPoint.run(objects, batch)

Executes a batch script that performs actions on the PowerPoint object model, using the RequestContext of previously-created API objects.

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>): OfficeExtension.IPromise<T>;

Parameters

objects

OfficeExtension.ClientObject[]

An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by "context.sync()".

batch

(context: PowerPoint.RequestContext) => OfficeExtension.IPromise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the PowerPoint application. Since the Office add-in and the PowerPoint application run in two different processes, the RequestContext is required to get access to the PowerPoint object model from the add-in.

Returns

OfficeExtension.IPromise<T>