Edit

Share via

Word.Interfaces.FillFormatLoadOptions interface

Package:
word

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the fill formatting for a shape or text.

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

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

$all

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

backgroundColor

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

backgroundColor?: Word.Interfaces.ColorFormatLoadOptions;

Property Value

Word.Interfaces.ColorFormatLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

foregroundColor

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

foregroundColor?: Word.Interfaces.ColorFormatLoadOptions;

Property Value

Word.Interfaces.ColorFormatLoadOptions

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

gradientAngle

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

gradientAngle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

gradientColorType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the gradient color type.

gradientColorType?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

gradientDegree

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

gradientStyle

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the gradient style for the fill.

gradientStyle?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

gradientVariant

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

gradientVariant?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isVisible

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

isVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

pattern

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

pattern?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

presetGradientType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the preset gradient type for the fill.

presetGradientType?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

presetTexture

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the preset texture.

presetTexture?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

rotateWithObject

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies whether the fill rotates with the shape.

rotateWithObject?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

textureAlignment

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

textureAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

textureHorizontalScale

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the horizontal scaling factor for the texture fill.

textureHorizontalScale?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

textureName

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

textureName?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

textureOffsetX

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

textureOffsetX?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

textureOffsetY

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies the vertical offset of the texture.

textureOffsetY?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

textureTile

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Specifies whether the texture is tiled.

textureTile?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

textureType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns the texture type for the fill.

textureType?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

textureVerticalScale

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

textureVerticalScale?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

transparency

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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

transparency?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

type

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the fill format type.

type?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]