powerpoint package

Represents an Office.js binding that is defined in the presentation.

Represents the collection of all the binding objects that are part of the presentation.

Represents the properties for a table cell border.

Represents the borders for a table cell.

Represents the bullet formatting properties of a text that is attached to the PowerPoint.ParagraphFormat.

Represents a custom property.

A collection of custom properties.

Represents a custom XML part object.

A collection of custom XML parts.

A scoped collection of custom XML parts. A scoped collection is the result of some operation (such as filtering by namespace). A scoped collection cannot be scoped any further.

Represents presentation properties.

Represents a single hyperlink.

Represents a collection of hyperlinks.

Represents the margins of a table cell.

Represents the page setup information for the presentation.

Represents the paragraph formatting properties of a text that is attached to the PowerPoint.TextRange.

Represents the properties of a placeholder shape.

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.

Represents a single shape in the slide.

Represents the collection of shapes.

Represents the fill formatting of a shape object.

Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.

Represents a shape group inside a presentation. To get the corresponding Shape object, use ShapeGroup.shape.

Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.

Represents a collection of shapes.

Represents a single slide of a presentation.

Represents a background of a slide.

Represents the fill formatting of a slide background object.

Represents PowerPoint.SlideBackground gradient fill properties.

Represents PowerPoint.SlideBackground pattern fill properties.

Represents PowerPoint.SlideBackground picture or texture fill properties.

Represents PowerPoint.SlideBackground solid fill properties.

Represents the collection of slides in the presentation.

Represents the layout of a slide.

Represents the background of a slide layout.

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

Represents the Slide Master of a slide.

Represents the background of a slide master.

Represents the collection of Slide Masters in the presentation.

Represents a collection of slides in the presentation.

Represents a table.

Represents a table.

Represents a collection of table cells.

Represents a column in a table.

Represents a collection of table columns.

Represents a row in a table.

Represents a collection of table rows.

Represents the available table style options.

Represents a single tag in the slide.

Represents the collection of tags.

Represents the text frame of a shape object.

Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.

Represents a theme color scheme.

Represents the available options when adding a new slide.

Represents the properties for a table cell border.

Represents the fill formatting of a table cell.

Represents the font attributes, such as font name, size, and color.

Represents the available options when inserting slides.

An interface describing the data returned by calling bindingCollection.toJSON().

Represents the collection of all the binding objects that are part of the presentation.

An interface for updating data on the BindingCollection object, for use in bindingCollection.set({ ... }).

An interface describing the data returned by calling binding.toJSON().

Represents an Office.js binding that is defined in the presentation.

An interface describing the data returned by calling border.toJSON().

Represents the properties for a table cell border.

An interface describing the data returned by calling borders.toJSON().

Represents the borders for a table cell.

An interface for updating data on the Border object, for use in border.set({ ... }).

An interface describing the data returned by calling bulletFormat.toJSON().

Represents the bullet formatting properties of a text that is attached to the PowerPoint.ParagraphFormat.

An interface for updating data on the BulletFormat object, for use in bulletFormat.set({ ... }).

Provides ways to load properties of only a subset of members of a collection.

An interface describing the data returned by calling customPropertyCollection.toJSON().

A collection of custom properties.

An interface for updating data on the CustomPropertyCollection object, for use in customPropertyCollection.set({ ... }).

An interface describing the data returned by calling customProperty.toJSON().

Represents a custom property.

An interface for updating data on the CustomProperty object, for use in customProperty.set({ ... }).

An interface describing the data returned by calling customXmlPartCollection.toJSON().

A collection of custom XML parts.

An interface for updating data on the CustomXmlPartCollection object, for use in customXmlPartCollection.set({ ... }).

An interface describing the data returned by calling customXmlPart.toJSON().

Represents a custom XML part object.

An interface describing the data returned by calling customXmlPartScopedCollection.toJSON().

A scoped collection of custom XML parts. A scoped collection is the result of some operation (such as filtering by namespace). A scoped collection cannot be scoped any further.

An interface for updating data on the CustomXmlPartScopedCollection object, for use in customXmlPartScopedCollection.set({ ... }).

An interface describing the data returned by calling documentProperties.toJSON().

Represents presentation properties.

An interface for updating data on the DocumentProperties object, for use in documentProperties.set({ ... }).

An interface describing the data returned by calling hyperlinkCollection.toJSON().

Represents a collection of hyperlinks.

An interface for updating data on the HyperlinkCollection object, for use in hyperlinkCollection.set({ ... }).

An interface describing the data returned by calling hyperlink.toJSON().

Represents a single hyperlink.

An interface for updating data on the Hyperlink object, for use in hyperlink.set({ ... }).

An interface describing the data returned by calling margins.toJSON().

Represents the margins of a table cell.

An interface for updating data on the Margins object, for use in margins.set({ ... }).

An interface describing the data returned by calling pageSetup.toJSON().

Represents the page setup information for the presentation.

An interface for updating data on the PageSetup object, for use in pageSetup.set({ ... }).

An interface describing the data returned by calling paragraphFormat.toJSON().

Represents the paragraph formatting properties of a text that is attached to the PowerPoint.TextRange.

An interface for updating data on the ParagraphFormat object, for use in paragraphFormat.set({ ... }).

An interface describing the data returned by calling placeholderFormat.toJSON().

Represents the properties of a placeholder shape.

An interface describing the data returned by calling presentation.toJSON().

An interface describing the data returned by calling shapeCollection.toJSON().

Represents the collection of shapes.

An interface for updating data on the ShapeCollection object, for use in shapeCollection.set({ ... }).

An interface describing the data returned by calling shape.toJSON().

An interface describing the data returned by calling shapeFill.toJSON().

Represents the fill formatting of a shape object.

An interface for updating data on the ShapeFill object, for use in shapeFill.set({ ... }).

An interface describing the data returned by calling shapeFont.toJSON().

Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.

An interface for updating data on the ShapeFont object, for use in shapeFont.set({ ... }).

An interface describing the data returned by calling shapeGroup.toJSON().

Represents a shape group inside a presentation. To get the corresponding Shape object, use ShapeGroup.shape.

An interface describing the data returned by calling shapeLineFormat.toJSON().

Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.

An interface for updating data on the ShapeLineFormat object, for use in shapeLineFormat.set({ ... }).

Represents a single shape in the slide.

An interface describing the data returned by calling shapeScopedCollection.toJSON().

Represents a collection of shapes.

An interface for updating data on the ShapeScopedCollection object, for use in shapeScopedCollection.set({ ... }).

An interface for updating data on the Shape object, for use in shape.set({ ... }).

An interface describing the data returned by calling slideBackground.toJSON().

An interface describing the data returned by calling slideBackgroundFill.toJSON().

Represents the fill formatting of a slide background object.

An interface describing the data returned by calling slideBackgroundGradientFill.toJSON().

Represents PowerPoint.SlideBackground gradient fill properties.

An interface for updating data on the SlideBackgroundGradientFill object, for use in slideBackgroundGradientFill.set({ ... }).

Represents a background of a slide.

An interface describing the data returned by calling slideBackgroundPatternFill.toJSON().

Represents PowerPoint.SlideBackground pattern fill properties.

An interface for updating data on the SlideBackgroundPatternFill object, for use in slideBackgroundPatternFill.set({ ... }).

An interface describing the data returned by calling slideBackgroundPictureOrTextureFill.toJSON().

Represents PowerPoint.SlideBackground picture or texture fill properties.

An interface for updating data on the SlideBackgroundPictureOrTextureFill object, for use in slideBackgroundPictureOrTextureFill.set({ ... }).

An interface describing the data returned by calling slideBackgroundSolidFill.toJSON().

Represents PowerPoint.SlideBackground solid fill properties.

An interface for updating data on the SlideBackgroundSolidFill object, for use in slideBackgroundSolidFill.set({ ... }).

An interface for updating data on the SlideBackground object, for use in slideBackground.set({ ... }).

An interface describing the data returned by calling slideCollection.toJSON().

Represents the collection of slides in the presentation.

An interface for updating data on the SlideCollection object, for use in slideCollection.set({ ... }).

An interface describing the data returned by calling slide.toJSON().

An interface describing the data returned by calling slideLayoutBackground.toJSON().

Represents the background of a slide layout.

An interface for updating data on the SlideLayoutBackground object, for use in slideLayoutBackground.set({ ... }).

An interface describing the data returned by calling slideLayoutCollection.toJSON().

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

An interface for updating data on the SlideLayoutCollection object, for use in slideLayoutCollection.set({ ... }).

An interface describing the data returned by calling slideLayout.toJSON().

Represents the layout of a slide.

Represents a single slide of a presentation.

An interface describing the data returned by calling slideMasterBackground.toJSON().

Represents the background of a slide master.

An interface describing the data returned by calling slideMasterCollection.toJSON().

Represents the collection of Slide Masters in the presentation.

An interface for updating data on the SlideMasterCollection object, for use in slideMasterCollection.set({ ... }).

An interface describing the data returned by calling slideMaster.toJSON().

Represents the Slide Master of a slide.

An interface describing the data returned by calling slideScopedCollection.toJSON().

Represents a collection of slides in the presentation.

An interface for updating data on the SlideScopedCollection object, for use in slideScopedCollection.set({ ... }).

An interface describing the data returned by calling tableCellCollection.toJSON().

Represents a collection of table cells.

An interface for updating data on the TableCellCollection object, for use in tableCellCollection.set({ ... }).

An interface describing the data returned by calling tableCell.toJSON().

Represents a table.

An interface for updating data on the TableCell object, for use in tableCell.set({ ... }).

An interface describing the data returned by calling tableColumnCollection.toJSON().

Represents a collection of table columns.

An interface for updating data on the TableColumnCollection object, for use in tableColumnCollection.set({ ... }).

An interface describing the data returned by calling tableColumn.toJSON().

Represents a column in a table.

An interface for updating data on the TableColumn object, for use in tableColumn.set({ ... }).

An interface describing the data returned by calling table.toJSON().

Represents a table.

An interface describing the data returned by calling tableRowCollection.toJSON().

Represents a collection of table rows.

An interface for updating data on the TableRowCollection object, for use in tableRowCollection.set({ ... }).

An interface describing the data returned by calling tableRow.toJSON().

Represents a row in a table.

An interface for updating data on the TableRow object, for use in tableRow.set({ ... }).

An interface describing the data returned by calling tableStyleOptions.toJSON().

Represents the available table style options.

An interface for updating data on the TableStyleOptions object, for use in tableStyleOptions.set({ ... }).

An interface describing the data returned by calling tagCollection.toJSON().

Represents the collection of tags.

An interface for updating data on the TagCollection object, for use in tagCollection.set({ ... }).

An interface describing the data returned by calling tag.toJSON().

Represents a single tag in the slide.

An interface for updating data on the Tag object, for use in tag.set({ ... }).

An interface describing the data returned by calling textFrame.toJSON().

Represents the text frame of a shape object.

An interface for updating data on the TextFrame object, for use in textFrame.set({ ... }).

An interface describing the data returned by calling textRange.toJSON().

Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.

An interface for updating data on the TextRange object, for use in textRange.set({ ... }).

Represents the available options when adding shapes.

Represents the available options when getting an image of a shape. The image is scaled to fit into the desired dimensions. If width and height aren't specified, the true size of the shape is used. If only one of either width or height is specified, the other will be calculated to preserve aspect ratio. The resulting dimensions will automatically be clamped to the maximum supported size if too large.

Represents the available options for setting a PowerPoint.SlideBackground gradient fill.

Represents the available options for setting a PowerPoint.SlideBackground pattern fill.

Represents PowerPoint.SlideBackground picture or texture fill options.

Represents the available options for setting a PowerPoint.SlideBackground solid fill.

Represents the available options when getting an image of a slide.

Represents the available options when adding a table.

Represents the borders of a table cell.

Represents the margins of a table cell.

Represents the table cell properties to update.

Represents the available options when clearing a table.

Provides the table column properties.

Represents the properties of a merged area of cells in a table.

Provides the table row properties.

Represents a sequence of one or more characters with the same font attributes.

Represents the possible binding types.

Specifies the style of a bullet.

Specifies the type of a bullet.

Specifies the connector type for line shapes.

Specifies the document property type for custom properties.

Specifies the shape type for a GeometricShape object.

Specifies the formatting options for when slides are inserted.

Represents the horizontal alignment of the PowerPoint.TextFrame in a PowerPoint.Shape.

Specifies the type of a placeholder.

Determines the type of automatic sizing allowed.

Specifies a shape's fill type.

The type of underline applied to a font.

Represents the format of an image.

Specifies the dash style for a line.

Specifies the style for a line.

Specifies the type of a shape.

Use with setZOrder to move the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.

Specifies the fill type for a PowerPoint.SlideBackground.

Specifies the gradient fill type for a PowerPoint.SlideBackgroundGradientFill.

Specifies the pattern fill type for a PowerPoint.SlideBackgroundPatternFill.

Specifies the type of a slide layout.

Represents the available built-in table styles.

Represents the vertical alignment of a PowerPoint.TextFrame in a PowerPoint.Shape. If one of the centered options is selected, the contents of the TextFrame will be centered horizontally within the Shape as a group. To change the horizontal alignment of a text, see PowerPoint.ParagraphFormat and PowerPoint.ParagraphHorizontalAlignment.

Specifies the theme colors used in PowerPoint.

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

[ API set: PowerPointApi 1.1 ]

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.

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.

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