PowerPoint.Shape class

Package:

powerpoint

Represents a single shape in the slide.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi 1.3 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
id	Gets the unique ID of the shape.
tags	Returns a collection of tags in the shape.

Methods

delete()	Deletes the shape from the shape collection. Does nothing if the shape does not exist.
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.Shape object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.ShapeData) 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

id

Gets the unique ID of the shape.

readonly id: string;

Property Value

string

Remarks

[ API set: PowerPointApi 1.3 ]

tags

Returns a collection of tags in the shape.

readonly tags: PowerPoint.TagCollection;

Property Value

PowerPoint.TagCollection

Remarks

[ API set: PowerPointApi 1.3 ]

Method Details

delete()

Deletes the shape from the shape collection. Does nothing if the shape does not exist.

delete(): void;

Returns

void

Remarks

[ API set: PowerPointApi 1.3 ]

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.ShapeLoadOptions): PowerPoint.Shape;

Parameters

options

PowerPoint.Interfaces.ShapeLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.Shape

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

Parameters

propertyNames

string | string[]

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

Returns

PowerPoint.Shape

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

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

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

toJSON(): PowerPoint.Interfaces.ShapeData;

Returns

PowerPoint.Interfaces.ShapeData