Word.Interfaces.ShapeGroupData interface

An interface describing the data returned by calling shapeGroup.toJSON().

Properties

id

Gets an integer that represents the shape group identifier.

shape

Gets the Shape object associated with the group.

shapes

Gets the collection of Shape objects. Currently, only text boxes and geometric shapes are supported.

Property Details

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 an integer that represents the shape group identifier.

id?: number;

Property Value

number

Remarks

[ API set: WordApi 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.

Gets the Shape object associated with the group.

shape?: Word.Interfaces.ShapeData;

Property Value

Remarks

[ API set: WordApi 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.

Gets the collection of Shape objects. Currently, only text boxes and geometric shapes are supported.

shapes?: Word.Interfaces.ShapeData[];

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]