Edit

Share via

Word.Interfaces.ShadowFormatLoadOptions interface

Package:
word

Represents the shadow formatting for a shape or text in Word.

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

Specifies the blur level for a shadow format as a value between 0.0 and 100.0.
foregroundColor

Returns a ColorFormat object that represents the foreground color for the fill, line, or shadow.
isVisible

Specifies whether the object or the formatting applied to it is visible.
obscured

Specifies true if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, false if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill.
offsetX

Specifies the horizontal offset (in points) of the shadow from the shape. A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left.
offsetY

Specifies the vertical offset (in points) of the shadow from the shape. A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom.
rotateWithShape

Specifies whether to rotate the shadow when rotating the shape.
size

Specifies the width of the shadow.
style

Specifies the type of shadow formatting to apply to a shape.
transparency

Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear).
type

Specifies the shape shadow type.

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

blur

Specifies the blur level for a shadow format as a value between 0.0 and 100.0.

blur?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

foregroundColor

Returns a ColorFormat object that represents the foreground color for the fill, line, or shadow.

foregroundColor?: Word.Interfaces.ColorFormatLoadOptions;

Property Value

Word.Interfaces.ColorFormatLoadOptions

Remarks

[ API set: WordApiDesktop 1.3 ]

isVisible

Specifies whether the object or the formatting applied to it is visible.

isVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

obscured

Specifies true if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, false if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill.

obscured?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

offsetX

Specifies the horizontal offset (in points) of the shadow from the shape. A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left.

offsetX?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

offsetY

Specifies the vertical offset (in points) of the shadow from the shape. A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom.

offsetY?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

rotateWithShape

Specifies whether to rotate the shadow when rotating the shape.

rotateWithShape?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

size

Specifies the width of the shadow.

size?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

style

Specifies the type of shadow formatting to apply to a shape.

style?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

transparency

Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear).

transparency?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

type

Specifies the shape shadow type.

type?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]