Word.Interfaces.FillFormatUpdateData interface
An interface for updating data on the FillFormat object, for use in fillFormat.set({ ... }).
Properties
| background |
Returns a |
| foreground |
Returns a |
| gradient |
Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. |
| is |
Specifies if the object, or the formatting applied to it, is visible. |
| rotate |
Specifies whether the fill rotates with the shape. |
| texture |
Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. |
| texture |
Specifies the horizontal scaling factor for the texture fill. |
| texture |
Specifies the horizontal offset of the texture from the origin in points. |
| texture |
Specifies the vertical offset of the texture. |
| texture |
Specifies whether the texture is tiled. |
| texture |
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
foregroundColor
Returns a ColorFormat object that represents the foreground color for the fill.
foregroundColor?: Word.Interfaces.ColorFormatUpdateData;
Property Value
Remarks
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
isVisible
Specifies if the object, or the formatting applied to it, is visible.
isVisible?: boolean;
Property Value
boolean
Remarks
rotateWithObject
Specifies whether the fill rotates with the shape.
rotateWithObject?: boolean;
Property Value
boolean
Remarks
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
textureHorizontalScale
Specifies the horizontal scaling factor for the texture fill.
textureHorizontalScale?: number;
Property Value
number
Remarks
textureOffsetX
Specifies the horizontal offset of the texture from the origin in points.
textureOffsetX?: number;
Property Value
number
Remarks
textureOffsetY
Specifies the vertical offset of the texture.
textureOffsetY?: number;
Property Value
number
Remarks
textureTile
Specifies whether the texture is tiled.
textureTile?: boolean;
Property Value
boolean
Remarks
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
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