Edit

Share via

Word.Interfaces.FillFormatData interface

Package:
word

An interface describing the data returned by calling fillFormat.toJSON().

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.
gradientColorType

Gets the gradient color type.
gradientDegree

Returns how dark or light a one-color gradient fill is. A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. A value of 1 means that white is mixed in. Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in.
gradientStyle

Returns the gradient style for the fill.
gradientVariant

Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills.
isVisible

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

Returns a PatternType value that represents the pattern applied to the fill or line.
presetGradientType

Returns the preset gradient type for the fill.
presetTexture

Gets the preset texture.
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.
textureName

Returns the name of the custom texture file for the 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.
textureType

Returns the texture type for the fill.
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).
type

Gets the fill format type.

Property Details

backgroundColor

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

backgroundColor?: Word.Interfaces.ColorFormatData;

Property Value

Word.Interfaces.ColorFormatData

Remarks

[ API set: WordApiDesktop 1.3 ]

foregroundColor

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

foregroundColor?: Word.Interfaces.ColorFormatData;

Property Value

Word.Interfaces.ColorFormatData

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 ]

gradientColorType

Gets the gradient color type.

gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor";

Property Value

Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"

Remarks

[ API set: WordApiDesktop 1.3 ]

gradientDegree

Returns how dark or light a one-color gradient fill is. A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. A value of 1 means that white is mixed in. Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in.

gradientDegree?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.3 ]

gradientStyle

Returns the gradient style for the fill.

gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter";

Property Value

Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"

Remarks

[ API set: WordApiDesktop 1.3 ]

gradientVariant

Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills.

gradientVariant?: 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 ]

pattern

Returns a PatternType value that represents the pattern applied to the fill or line.

pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross";

Property Value

Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"

Remarks

[ API set: WordApiDesktop 1.3 ]

presetGradientType

Returns the preset gradient type for the fill.

presetGradientType?: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire";

Property Value

Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"

Remarks

[ API set: WordApiDesktop 1.3 ]

presetTexture

Gets the preset texture.

presetTexture?: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood";

Property Value

Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"

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 ]

textureName

Returns the name of the custom texture file for the fill.

textureName?: string;

Property Value

string

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 ]

textureType

Returns the texture type for the fill.

textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined";

Property Value

Word.TextureType | "Mixed" | "Preset" | "UserDefined"

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 ]

type

Gets the fill format type.

type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture";

Property Value

Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"

Remarks

[ API set: WordApiDesktop 1.3 ]