Word.Interfaces.FrameCollectionLoadOptions interface
Represents the collection of Word.Frame objects.
Properties
| $all | Specifying |
| height | For EACH ITEM in the collection: Specifies the height (in points) of the frame. |
| height |
For EACH ITEM in the collection: Specifies a |
| horizontal |
For EACH ITEM in the collection: Specifies the horizontal distance between the frame and the surrounding text, in points. |
| horizontal |
For EACH ITEM in the collection: Specifies the horizontal distance between the edge of the frame and the item specified by the |
| lock |
For EACH ITEM in the collection: Specifies if the frame is locked. |
| range | For EACH ITEM in the collection: Returns a |
| relative |
For EACH ITEM in the collection: Specifies the relative horizontal position of the frame. |
| relative |
For EACH ITEM in the collection: Specifies the relative vertical position of the frame. |
| shading | For EACH ITEM in the collection: Returns a |
| text |
For EACH ITEM in the collection: Specifies if document text wraps around the frame. |
| vertical |
For EACH ITEM in the collection: Specifies the vertical distance (in points) between the frame and the surrounding text. |
| vertical |
For EACH ITEM in the collection: Specifies the vertical distance between the edge of the frame and the item specified by the |
| width | For EACH ITEM in the collection: Specifies the width (in points) of the frame. |
| width |
For EACH ITEM in the collection: 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
For EACH ITEM in the collection: Specifies the height (in points) of the frame.
height?: boolean;Property Value
boolean
Remarks
heightRule
For EACH ITEM in the collection: Specifies a FrameSizeRule value that represents the rule for determining the height of the frame.
heightRule?: boolean;Property Value
boolean
Remarks
horizontalDistanceFromText
For EACH ITEM in the collection: Specifies the horizontal distance between the frame and the surrounding text, in points.
horizontalDistanceFromText?: boolean;Property Value
boolean
Remarks
horizontalPosition
For EACH ITEM in the collection: Specifies the horizontal distance between the edge of the frame and the item specified by the relativeHorizontalPosition property.
horizontalPosition?: boolean;Property Value
boolean
Remarks
lockAnchor
For EACH ITEM in the collection: Specifies if the frame is locked.
lockAnchor?: boolean;Property Value
boolean
Remarks
range
For EACH ITEM in the collection: Returns a Range object that represents the portion of the document that's contained within the frame.
range?: Word.Interfaces.RangeLoadOptions;Property Value
Remarks
relativeHorizontalPosition
For EACH ITEM in the collection: Specifies the relative horizontal position of the frame.
relativeHorizontalPosition?: boolean;Property Value
boolean
Remarks
relativeVerticalPosition
For EACH ITEM in the collection: Specifies the relative vertical position of the frame.
relativeVerticalPosition?: boolean;Property Value
boolean
Remarks
shading
For EACH ITEM in the collection: Returns a ShadingUniversal object that refers to the shading formatting for the frame.
shading?: Word.Interfaces.ShadingUniversalLoadOptions;Property Value
Remarks
textWrap
For EACH ITEM in the collection: Specifies if document text wraps around the frame.
textWrap?: boolean;Property Value
boolean
Remarks
verticalDistanceFromText
For EACH ITEM in the collection: Specifies the vertical distance (in points) between the frame and the surrounding text.
verticalDistanceFromText?: boolean;Property Value
boolean
Remarks
verticalPosition
For EACH ITEM in the collection: Specifies the vertical distance between the edge of the frame and the item specified by the relativeVerticalPosition property.
verticalPosition?: boolean;Property Value
boolean
Remarks
width
For EACH ITEM in the collection: Specifies the width (in points) of the frame.
width?: boolean;Property Value
boolean
Remarks
widthRule
For EACH ITEM in the collection: Specifies the rule used to determine the width of the frame.
widthRule?: boolean;Property Value
boolean