Edit

Share via

Word.Interfaces.FrameLoadOptions interface

Package:
word

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.

Represents a frame. The Frame object is a member of the Word.FrameCollection object.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
height

Specifies the height (in points) of the frame.
heightRule

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

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

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

Specifies if the frame is locked.
range

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

Specifies the relative horizontal position of the frame.
relativeVerticalPosition

Specifies the relative vertical position of the frame.
shading

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

Specifies if document text wraps around the frame.
verticalDistanceFromText

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

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

Specifies the width (in points) of the frame.
widthRule

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

Property Details

$all

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.

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

height

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.

Specifies the height (in points) of the frame.

height?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

heightRule

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.

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

heightRule?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

horizontalDistanceFromText

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.

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

horizontalDistanceFromText?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

horizontalPosition

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.

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

horizontalPosition?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

lockAnchor

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.

Specifies if the frame is locked.

lockAnchor?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

range

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.

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

range?: Word.Interfaces.RangeLoadOptions;

Property Value

Word.Interfaces.RangeLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

relativeHorizontalPosition

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.

Specifies the relative horizontal position of the frame.

relativeHorizontalPosition?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

relativeVerticalPosition

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.

Specifies the relative vertical position of the frame.

relativeVerticalPosition?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

shading

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.

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

shading?: Word.Interfaces.ShadingUniversalLoadOptions;

Property Value

Word.Interfaces.ShadingUniversalLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

textWrap

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.

Specifies if document text wraps around the frame.

textWrap?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

verticalDistanceFromText

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.

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

verticalDistanceFromText?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

verticalPosition

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.

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

verticalPosition?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

width

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.

Specifies the width (in points) of the frame.

width?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

widthRule

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.

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

widthRule?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]