Word.Interfaces.FrameUpdateData interface
An interface for updating data on the Frame object, for use in frame.set({ ... }).
Properties
| height | Specifies the height (in points) of the frame. |
| height |
Specifies a |
| horizontal |
Specifies the horizontal distance between the frame and the surrounding text, in points. |
| horizontal |
Specifies the horizontal distance between the edge of the frame and the item specified by the |
| lock |
Specifies if the frame is locked. |
| range | Returns a |
| relative |
Specifies the relative horizontal position of the frame. |
| relative |
Specifies the relative vertical position of the frame. |
| shading | Returns a |
| text |
Specifies if document text wraps around the frame. |
| vertical |
Specifies the vertical distance (in points) between the frame and the surrounding text. |
| vertical |
Specifies the vertical distance between the edge of the frame and the item specified by the |
| width | Specifies the width (in points) of the frame. |
| width |
Specifies the rule used to determine the width of the frame. |
Property Details
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?: number;Property Value
number
Remarks
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?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";Property Value
Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"
Remarks
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?: number;Property Value
number
Remarks
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?: number;Property Value
number
Remarks
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
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.RangeUpdateData;Property Value
Remarks
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?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";Property Value
Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"
Remarks
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?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";Property Value
Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
Remarks
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.ShadingUniversalUpdateData;Property Value
Remarks
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
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?: number;Property Value
number
Remarks
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?: number;Property Value
number
Remarks
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?: number;Property Value
number
Remarks
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?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";Property Value
Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"