Edit

Share via

Word.Interfaces.FrameLoadOptions interface

Package:
word

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

Remarks

[ API set: WordApiDesktop 1.3 ]

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

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

Specifies the height (in points) of the frame.

height?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

heightRule

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

heightRule?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

horizontalDistanceFromText

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

horizontalDistanceFromText?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

horizontalPosition

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: WordApiDesktop 1.3 ]

lockAnchor

Specifies if the frame is locked.

lockAnchor?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

range

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: WordApiDesktop 1.3 ]

relativeHorizontalPosition

Specifies the relative horizontal position of the frame.

relativeHorizontalPosition?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

relativeVerticalPosition

Specifies the relative vertical position of the frame.

relativeVerticalPosition?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

shading

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: WordApiDesktop 1.3 ]

textWrap

Specifies if document text wraps around the frame.

textWrap?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

verticalDistanceFromText

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

verticalDistanceFromText?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

verticalPosition

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: WordApiDesktop 1.3 ]

width

Specifies the width (in points) of the frame.

width?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

widthRule

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

widthRule?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]