Word.FillFormat class

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

readonly backgroundColor: Word.ColorFormat;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

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

readonly foregroundColor: Word.ColorFormat;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

gradientAngle: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Gets the gradient color type.

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

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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.

readonly gradientDegree: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Returns the gradient style for the fill.

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

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

readonly gradientVariant: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

isVisible: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

readonly 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

Remarks

[ API set: WordApiDesktop 1.3 ]

Returns the preset gradient type for the fill.

readonly 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

Remarks

[ API set: WordApiDesktop 1.3 ]

Gets the preset texture.

readonly 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

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies whether the fill rotates with the shape.

rotateWithObject: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the horizontal scaling factor for the texture fill.

textureHorizontalScale: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

readonly textureName: string;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

textureOffsetX: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies the vertical offset of the texture.

textureOffsetY: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Specifies whether the texture is tiled.

textureTile: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Returns the texture type for the fill.

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

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

textureVerticalScale: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

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

Remarks

[ API set: WordApiDesktop 1.3 ]

Gets the fill format type.

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

Property Value

Remarks

[ API set: WordApiDesktop 1.3 ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Word.Interfaces.FillFormatLoadOptions): Word.FillFormat;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Word.FillFormat;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.FillFormat;

Parameters

Returns

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.FillFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.FillFormat): void;

Parameters

Returns

Sets the fill to a one-color gradient.

setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void;

Parameters

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

Sets the fill to a one-color gradient.

setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void;

Parameters

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

Sets the fill to a pattern.

setPatterned(pattern: Word.PatternType): void;

Parameters

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

Sets the fill to a pattern.

setPatterned(pattern: "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"): void;

Parameters

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

Sets the fill to a preset gradient. The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type.

setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void;

Parameters

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

Sets the fill to a preset gradient. The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type.

setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, 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"): void;

Parameters

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

Sets the fill to a preset texture.

setPresetTextured(presetTexture: Word.PresetTexture): void;

Parameters

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

Sets the fill to a preset texture.

setPresetTextured(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"): void;

Parameters

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

Sets the fill to a two-color gradient.

setTwoColorGradient(style: Word.GradientStyle, variant: number): void;

Parameters

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

Sets the fill to a two-color gradient.

setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void;

Parameters

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

Sets the fill to a uniform color.

solid(): void;

Returns

Remarks

[ API set: WordApiDesktop 1.3 ]

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.FillFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.FillFormatData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.FillFormatData;

Returns

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

track(): Word.FillFormat;

Returns

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

untrack(): Word.FillFormat;

Returns