Word.Frame class

Returns a BorderUniversalCollection object that represents all the borders for the frame.

readonly borders: Word.BorderUniversalCollection;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Specifies the height (in points) of the frame.

height: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies a FrameSizeRule value that represents the rule for determining the height of the frame.

heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the horizontal distance between the frame and the surrounding text, in points.

horizontalDistanceFromText: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the horizontal distance between the edge of the frame and the item specified by the relativeHorizontalPosition property.

horizontalPosition: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies if the frame is locked.

lockAnchor: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Returns a Range object that represents the portion of the document that's contained within the frame.

readonly range: Word.Range;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the relative horizontal position of the frame.

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

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the relative vertical position of the frame.

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

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Returns a ShadingUniversal object that refers to the shading formatting for the frame.

readonly shading: Word.ShadingUniversal;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies if document text wraps around the frame.

textWrap: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the vertical distance (in points) between the frame and the surrounding text.

verticalDistanceFromText: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the vertical distance between the edge of the frame and the item specified by the relativeVerticalPosition property.

verticalPosition: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the width (in points) of the frame.

width: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the rule used to determine the width of the frame.

widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Copies the frame to the Clipboard.

copy(): void;

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

Removes the frame from the document and places it on the Clipboard.

cut(): void;

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

Deletes the frame.

delete(): void;

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

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

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

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

Parameters

Returns

Selects the frame.

select(): void;

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

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

toJSON(): Word.Interfaces.FrameData;

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

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

Returns