Edit

Share via


Word.Interfaces.FillFormatUpdateData interface

An interface for updating data on the FillFormat object, for use in fillFormat.set({ ... }).

Properties

backgroundColor

Returns a ColorFormat object that represents the background color for the fill.

foregroundColor

Returns a ColorFormat object that represents the foreground color for the fill.

gradientAngle

Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9.

isVisible

Specifies if the object, or the formatting applied to it, is visible.

rotateWithObject

Specifies whether the fill rotates with the shape.

textureAlignment

Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill.

textureHorizontalScale

Specifies the horizontal scaling factor for the texture fill.

textureOffsetX

Specifies the horizontal offset of the texture from the origin in points.

textureOffsetY

Specifies the vertical offset of the texture.

textureTile

Specifies whether the texture is tiled.

textureVerticalScale

Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0.

transparency

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

Property Details

backgroundColor

Returns a ColorFormat object that represents the background color for the fill.

backgroundColor?: Word.Interfaces.ColorFormatUpdateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

foregroundColor

Returns a ColorFormat object that represents the foreground color for the fill.

foregroundColor?: Word.Interfaces.ColorFormatUpdateData;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

gradientAngle

Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9.

gradientAngle?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

isVisible

Specifies if the object, or the formatting applied to it, is visible.

isVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

rotateWithObject

Specifies whether the fill rotates with the shape.

rotateWithObject?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

textureAlignment

Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill.

textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight";

Property Value

Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"

Remarks

[ API set: WordApiDesktop 1.3 ]

textureHorizontalScale

Specifies the horizontal scaling factor for the texture fill.

textureHorizontalScale?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

textureOffsetX

Specifies the horizontal offset of the texture from the origin in points.

textureOffsetX?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

textureOffsetY

Specifies the vertical offset of the texture.

textureOffsetY?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

textureTile

Specifies whether the texture is tiled.

textureTile?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.3 ]

textureVerticalScale

Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0.

textureVerticalScale?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

transparency

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

transparency?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]