PowerPoint.ShapeGroup class

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

Extends

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

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

shape

Returns the Shape object associated with the group.

shapes

Returns the collection of Shape objects in the group.

Methods

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's passed to it.) Whereas the original PowerPoint.ShapeGroup object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.ShapeGroupData) that contains shallow copies of any loaded child properties from the original object.

ungroup()

Ungroups any grouped shapes in the specified shape group.

Property Details

context

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

id

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the unique ID of the shape group.

readonly id: string;

Property Value

string

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

shape

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the Shape object associated with the group.

readonly shape: PowerPoint.Shape;

Property Value

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

shapes

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the collection of Shape objects in the group.

readonly shapes: PowerPoint.ShapeScopedCollection;

Property Value

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Method Details

load(options)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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.ShapeGroupLoadOptions): PowerPoint.ShapeGroup;

Parameters

options
PowerPoint.Interfaces.ShapeGroupLoadOptions

Provides options for which properties of the object to load.

Returns

load(propertyNames)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

Parameters

propertyNames

string | string[]

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

Returns

load(propertyNamesAndPaths)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

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

toJSON()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

toJSON(): PowerPoint.Interfaces.ShapeGroupData;

Returns

ungroup()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Ungroups any grouped shapes in the specified shape group.

ungroup(): void;

Returns

void

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]