Excel.GroupShapeCollection class

Package:

excel

Represents the shape collection inside a shape group.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.9 ]

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()	Returns the number of shapes in the shape group.
getItem(key)	Gets a shape using its name or ID.
getItemAt(index)	Gets a shape based on its position in the collection.
getItemOrNullObject(key)	Gets a shape using its name or ID. If the shape object does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
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 Excel.GroupShapeCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.GroupShapeCollectionData) 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.

TypeScript

context: RequestContext;

Property Value

Excel.RequestContext

items

Gets the loaded child items in this collection.

TypeScript

readonly items: Excel.Shape[];

Property Value

Excel.Shape[]

Method Details

getCount()

Returns the number of shapes in the shape group.

TypeScript

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

Remarks

[ API set: ExcelApi 1.9 ]

getItem(key)

Gets a shape using its name or ID.

TypeScript

getItem(key: string): Excel.Shape;

Parameters

key

string

The name or ID of the shape to be retrieved.

Returns

Excel.Shape

Remarks

[ API set: ExcelApi 1.9 ]

getItemAt(index)

Gets a shape based on its position in the collection.

TypeScript

getItemAt(index: number): Excel.Shape;

Parameters

index

number

The zero-based index value of the object to be retrieved.

Returns

Excel.Shape

Remarks

[ API set: ExcelApi 1.9 ]

getItemOrNullObject(key)

Gets a shape using its name or ID. If the shape object does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

TypeScript

getItemOrNullObject(key: string): Excel.Shape;

Parameters

key

string

The name or ID of the shape to be retrieved.

Returns

Excel.Shape

Remarks

[ API set: ExcelApi 1.14 ]

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

TypeScript

load(options?: Excel.Interfaces.GroupShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.GroupShapeCollection;

Parameters

options

Excel.Interfaces.GroupShapeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.GroupShapeCollection

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

TypeScript

load(propertyNames?: string | string[]): Excel.GroupShapeCollection;

Parameters

propertyNames

string | string[]

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

Returns

Excel.GroupShapeCollection

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

TypeScript

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.GroupShapeCollection;

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

Excel.GroupShapeCollection

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

TypeScript

toJSON(): Excel.Interfaces.GroupShapeCollectionData;

Returns

Excel.Interfaces.GroupShapeCollectionData