Word.ShapeCollection class

Package:

word

Contains a collection of Word.Shape objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: WordApiDesktop 1.2 ]

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

getByGeometricTypes(types)	Gets the shapes that have the specified geometric types. Only applied to geometric shapes.
getById(id)	Gets a shape by its identifier. Throws an ItemNotFound error if there isn't a shape with the identifier in this collection.
getByIdOrNullObject(id)	Gets a shape by its identifier. If there isn't a shape with the identifier in this collection, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getByIds(ids)	Gets the shapes by the identifiers.
getByNames(names)	Gets the shapes that have the specified names.
getByTypes(types)	Gets the shapes that have the specified types.
getFirst()	Gets the first shape in this collection. Throws an ItemNotFound error if this collection is empty.
getFirstOrNullObject()	Gets the first shape in this collection. If this collection is empty, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
group()	Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes.
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 Word.ShapeCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.ShapeCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
track()	Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
untrack()	Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

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

Word.RequestContext

items

Gets the loaded child items in this collection.

readonly items: Word.Shape[];

Property Value

Word.Shape[]

Method Details

getByGeometricTypes(types)

Gets the shapes that have the specified geometric types. Only applied to geometric shapes.

getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection;

Parameters

types

Word.GeometricShapeType[]

Required. An array of geometric shape subtypes.

Returns

Word.ShapeCollection

Remarks

[ API set: WordApiDesktop 1.2 ]

getById(id)

Gets a shape by its identifier. Throws an ItemNotFound error if there isn't a shape with the identifier in this collection.

getById(id: number): Word.Shape;

Parameters

id

number

Required. A shape identifier.

Returns

Word.Shape

Remarks

[ API set: WordApiDesktop 1.2 ]

getByIdOrNullObject(id)

Gets a shape by its identifier. If there isn't a shape with the identifier in this collection, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

getByIdOrNullObject(id: number): Word.Shape;

Parameters

id

number

Required. A shape identifier.

Returns

Word.Shape

Remarks

[ API set: WordApiDesktop 1.2 ]

getByIds(ids)

Gets the shapes by the identifiers.

getByIds(ids: number[]): Word.ShapeCollection;

Parameters

ids

number[]

Required. An array of shape identifiers.

Returns

Word.ShapeCollection

Remarks

[ API set: WordApiDesktop 1.2 ]

getByNames(names)

Gets the shapes that have the specified names.

getByNames(names: string[]): Word.ShapeCollection;

Parameters

names

string[]

Required. An array of shape names.

Returns

Word.ShapeCollection

Remarks

[ API set: WordApiDesktop 1.2 ]

getByTypes(types)

Gets the shapes that have the specified types.

getByTypes(types: Word.ShapeType[]): Word.ShapeCollection;

Parameters

types

Word.ShapeType[]

Required. An array of shape types.

Returns

Word.ShapeCollection

Remarks

[ API set: WordApiDesktop 1.2 ]

getFirst()

Gets the first shape in this collection. Throws an ItemNotFound error if this collection is empty.

getFirst(): Word.Shape;

Returns

Word.Shape

Remarks

[ API set: WordApiDesktop 1.2 ]

getFirstOrNullObject()

Gets the first shape in this collection. If this collection is empty, then this method will return an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

getFirstOrNullObject(): Word.Shape;

Returns

Word.Shape

Remarks

[ API set: WordApiDesktop 1.2 ]

group()

Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes.

group(): Word.Shape;

Returns

Word.Shape

Remarks

[ API set: WordApiDesktop 1.2 ]

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?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection;

Parameters

options

Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

Word.ShapeCollection

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[]): Word.ShapeCollection;

Parameters

propertyNames

string | string[]

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

Returns

Word.ShapeCollection

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): Word.ShapeCollection;

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

Word.ShapeCollection

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

toJSON(): Word.Interfaces.ShapeCollectionData;

Returns

Word.Interfaces.ShapeCollectionData

track()

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

track(): Word.ShapeCollection;

Returns

Word.ShapeCollection

untrack()

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

untrack(): Word.ShapeCollection;

Returns

Word.ShapeCollection