Edit

Share via

Word.Interfaces.ShapeCollectionLoadOptions interface

  • Reference
Package:
word

Contains a collection of Word.Shape objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.

Remarks

[ API set: WordApiDesktop 1.2 ]

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).
allowOverlap

For EACH ITEM in the collection: Specifies whether a given shape can overlap other shapes.
altTextDescription

For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the shape.
body

For EACH ITEM in the collection: Represents the body object of the shape. Only applies to text boxes and geometric shapes.
canvas

For EACH ITEM in the collection: Gets the canvas associated with the shape. An object with its isNullObject property set to true will be returned if the shape type isn't "Canvas". For further information, see *OrNullObject methods and properties.
fill

For EACH ITEM in the collection: Returns the fill formatting of the shape.
geometricShapeType

For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape.
height

For EACH ITEM in the collection: The height, in points, of the shape.
heightRelative

For EACH ITEM in the collection: The percentage of shape height to vertical relative size, see Word.RelativeSize. For an inline or child shape, it can't be set.
id

For EACH ITEM in the collection: Gets an integer that represents the shape identifier.
isChild

For EACH ITEM in the collection: Check whether this shape is a child of a group shape or a canvas shape.
left

For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal relative position, see Word.RelativeHorizontalPosition. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
leftRelative

For EACH ITEM in the collection: The relative left position as a percentage from the left side of the shape to the horizontal relative position, see Word.RelativeHorizontalPosition. For an inline or child shape, it will return 0 and can't be set.
lockAspectRatio

For EACH ITEM in the collection: Specifies if the aspect ratio of this shape is locked.
name

For EACH ITEM in the collection: The name of the shape.
parentCanvas

For EACH ITEM in the collection: Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas.
parentGroup

For EACH ITEM in the collection: Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group.
relativeHorizontalPosition

For EACH ITEM in the collection: The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see Word.RelativeHorizontalPosition.
relativeHorizontalSize

For EACH ITEM in the collection: The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see Word.RelativeHorizontalPosition.
relativeVerticalPosition

For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see Word.RelativeVerticalPosition.
relativeVerticalSize

For EACH ITEM in the collection: The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see Word.RelativeHorizontalPosition.
rotation

For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape.
shapeGroup

For EACH ITEM in the collection: Gets the shape group associated with the shape. An object with its isNullObject property set to true will be returned if the shape type isn't "GroupShape". For further information, see *OrNullObject methods and properties.
textFrame

For EACH ITEM in the collection: Gets the text frame object of the shape.
textWrap

For EACH ITEM in the collection: Returns the text wrap formatting of the shape.
top

For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position, see Word.RelativeVerticalPosition. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
topRelative

For EACH ITEM in the collection: The relative top position as a percentage from the top edge of the shape to the vertical relative position, see Word.RelativeVerticalPosition. For an inline or child shape, it will return 0 and can't be set.
type

For EACH ITEM in the collection: Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
visible

For EACH ITEM in the collection: Specifies if the shape is visible. Not applicable to inline shapes.
width

For EACH ITEM in the collection: The width, in points, of the shape.
widthRelative

For EACH ITEM in the collection: The percentage of shape width to horizontal relative size, see Word.RelativeSize. For an inline or child shape, it can't be set.

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

allowOverlap

For EACH ITEM in the collection: Specifies whether a given shape can overlap other shapes.

allowOverlap?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

altTextDescription

For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the shape.

altTextDescription?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

body

For EACH ITEM in the collection: Represents the body object of the shape. Only applies to text boxes and geometric shapes.

body?: Word.Interfaces.BodyLoadOptions;

Property Value

Word.Interfaces.BodyLoadOptions

Remarks

[ API set: WordApiDesktop 1.2 ]

canvas

For EACH ITEM in the collection: Gets the canvas associated with the shape. An object with its isNullObject property set to true will be returned if the shape type isn't "Canvas". For further information, see *OrNullObject methods and properties.

canvas?: Word.Interfaces.CanvasLoadOptions;

Property Value

Word.Interfaces.CanvasLoadOptions

Remarks

[ API set: WordApiDesktop 1.2 ]

fill

For EACH ITEM in the collection: Returns the fill formatting of the shape.

fill?: Word.Interfaces.ShapeFillLoadOptions;

Property Value

Word.Interfaces.ShapeFillLoadOptions

Remarks

[ API set: WordApiDesktop 1.2 ]

geometricShapeType

For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape.

geometricShapeType?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

height

For EACH ITEM in the collection: The height, in points, of the shape.

height?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

heightRelative

For EACH ITEM in the collection: The percentage of shape height to vertical relative size, see Word.RelativeSize. For an inline or child shape, it can't be set.

heightRelative?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

id

For EACH ITEM in the collection: Gets an integer that represents the shape identifier.

id?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

isChild

For EACH ITEM in the collection: Check whether this shape is a child of a group shape or a canvas shape.

isChild?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

left

For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal relative position, see Word.RelativeHorizontalPosition. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.

left?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

leftRelative

For EACH ITEM in the collection: The relative left position as a percentage from the left side of the shape to the horizontal relative position, see Word.RelativeHorizontalPosition. For an inline or child shape, it will return 0 and can't be set.

leftRelative?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

lockAspectRatio

For EACH ITEM in the collection: Specifies if the aspect ratio of this shape is locked.

lockAspectRatio?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

name

For EACH ITEM in the collection: The name of the shape.

name?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

parentCanvas

For EACH ITEM in the collection: Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas.

parentCanvas?: Word.Interfaces.ShapeLoadOptions;

Property Value

Word.Interfaces.ShapeLoadOptions

Remarks

[ API set: WordApiDesktop 1.2 ]

parentGroup

For EACH ITEM in the collection: Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group.

parentGroup?: Word.Interfaces.ShapeLoadOptions;

Property Value

Word.Interfaces.ShapeLoadOptions

Remarks

[ API set: WordApiDesktop 1.2 ]

relativeHorizontalPosition

For EACH ITEM in the collection: The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see Word.RelativeHorizontalPosition.

relativeHorizontalPosition?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

relativeHorizontalSize

For EACH ITEM in the collection: The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see Word.RelativeHorizontalPosition.

relativeHorizontalSize?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

relativeVerticalPosition

For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see Word.RelativeVerticalPosition.

relativeVerticalPosition?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

relativeVerticalSize

For EACH ITEM in the collection: The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see Word.RelativeHorizontalPosition.

relativeVerticalSize?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

rotation

For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape.

rotation?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

shapeGroup

For EACH ITEM in the collection: Gets the shape group associated with the shape. An object with its isNullObject property set to true will be returned if the shape type isn't "GroupShape". For further information, see *OrNullObject methods and properties.

shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;

Property Value

Word.Interfaces.ShapeGroupLoadOptions

Remarks

[ API set: WordApiDesktop 1.2 ]

textFrame

For EACH ITEM in the collection: Gets the text frame object of the shape.

textFrame?: Word.Interfaces.TextFrameLoadOptions;

Property Value

Word.Interfaces.TextFrameLoadOptions

Remarks

[ API set: WordApiDesktop 1.2 ]

textWrap

For EACH ITEM in the collection: Returns the text wrap formatting of the shape.

textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;

Property Value

Word.Interfaces.ShapeTextWrapLoadOptions

Remarks

[ API set: WordApiDesktop 1.2 ]

top

For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position, see Word.RelativeVerticalPosition. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.

top?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

topRelative

For EACH ITEM in the collection: The relative top position as a percentage from the top edge of the shape to the vertical relative position, see Word.RelativeVerticalPosition. For an inline or child shape, it will return 0 and can't be set.

topRelative?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

type

For EACH ITEM in the collection: Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.

type?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

visible

For EACH ITEM in the collection: Specifies if the shape is visible. Not applicable to inline shapes.

visible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

width

For EACH ITEM in the collection: The width, in points, of the shape.

width?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]

widthRelative

For EACH ITEM in the collection: The percentage of shape width to horizontal relative size, see Word.RelativeSize. For an inline or child shape, it can't be set.

widthRelative?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.2 ]