Edit

Word.Interfaces.ShapeFillData interface

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

Remarks

Used by

Properties

backgroundColor

Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name.

foregroundColor

Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name.

transparency

Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns null if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.

type

Returns the fill type of the shape. See Word.ShapeFillType for details.

Property Details

backgroundColor

Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name.

backgroundColor?: string;

Property Value

string

Remarks

API set: WordApiDesktop 1.2

foregroundColor

Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name.

foregroundColor?: string;

Property Value

string

Remarks

API set: WordApiDesktop 1.2

transparency

Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns null if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.

transparency?: number;

Property Value

number

Remarks

API set: WordApiDesktop 1.2

type

Returns the fill type of the shape. See Word.ShapeFillType for details.

type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed";

Property Value

Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"

Remarks

API set: WordApiDesktop 1.2