Word.Shape class

Represents the body object of the shape. Only applies to TextBox shapes.

readonly body: Word.Body;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

The height, in points, of the shape.

height: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets an integer that represents the shape identifier.

readonly id: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set.

left: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

The relative horizontal position of the shape. For a floating shape, it can't be set.

relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

The relative vertical position of the shape. For a floating shape, it can't be set.

relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set.

top: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Gets the shape type. Currently, only TextBox shapes are supported.

readonly type: Word.ShapeType | "Unsupported" | "TextBox";

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

The width, in points, of the shape.

width: number;

Property Value

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Deletes the shape and its content.

delete(): void;

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

Parameters

Returns

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

Parameters

Returns

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

Parameters

Returns

Selects the shape.

select(selectMultipleShapes?: boolean): void;

Parameters

Returns

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.Shape): void;

Parameters

Returns

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

toJSON(): Word.Interfaces.ShapeData;

Returns

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

Returns

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

Returns