PowerPoint.ShapeScopedCollection class

Package:

powerpoint

Represents a collection of shapes.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: PowerPointApi 1.5 ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
items	Gets the loaded child items in this collection.

Methods

getCount()	Gets the number of shapes in the collection.
getItem(key)	Gets a shape using its unique ID. An error is thrown if the shape does not exist.
getItemAt(index)	Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
getItemOrNullObject(id)	Gets a shape using its unique ID. If such a shape does not exist, an object with an isNullObject property set to true is returned.
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.ShapeScopedCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.ShapeScopedCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

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

items

Gets the loaded child items in this collection.

readonly items: PowerPoint.Shape[];

Property Value

PowerPoint.Shape[]

Method Details

getCount()

Gets the number of shapes in the collection.

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

The number of shapes in the collection.

Remarks

[ API set: PowerPointApi 1.5 ]

getItem(key)

Gets a shape using its unique ID. An error is thrown if the shape does not exist.

getItem(key: string): PowerPoint.Shape;

Parameters

key

string

The ID of the shape.

Returns

PowerPoint.Shape

The shape with the unique ID. If such a shape does not exist, an error is thrown.

Remarks

[ API set: PowerPointApi 1.5 ]

getItemAt(index)

Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.

getItemAt(index: number): PowerPoint.Shape;

Parameters

index

number

The index of the shape in the collection.

Returns

PowerPoint.Shape

The shape at the given index. An error is thrown if index is out of range.

Remarks

[ API set: PowerPointApi 1.5 ]

getItemOrNullObject(id)

Gets a shape using its unique ID. If such a shape does not exist, an object with an isNullObject property set to true is returned.

getItemOrNullObject(id: string): PowerPoint.Shape;

Parameters

id

string

The ID of the shape.

Returns

PowerPoint.Shape

The shape with the unique ID. If such a shape does not exist, an object with an isNullObject property set to true is returned.

Remarks

[ API set: PowerPointApi 1.5 ]

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.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeScopedCollection;

Parameters

options

PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.ShapeScopedCollection

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

Parameters

propertyNames

string | string[]

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

Returns

PowerPoint.ShapeScopedCollection

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?: OfficeExtension.LoadOption): PowerPoint.ShapeScopedCollection;

Parameters

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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.ShapeScopedCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.ShapeScopedCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;

Returns

PowerPoint.Interfaces.ShapeScopedCollectionData