MsoFillFormatHelper

MsoFillFormatHelper class

Represents fill formatting for a shape.

class MsoFillFormatHelper;

Properties

Property	Type	Description
foreColor	Color	Gets and sets the fill fore color.
foreColorTransparency	number	Returns or sets the degree of fore color of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
backColor	Color	Gets and sets the file back color.
imageData	Uint8Array	Gets and sets the Texture and Picture fill data.
texture	TextureType	Readonly. Gets the texture fill type.
isVisible	boolean	Indicates whether there is fill.

Methods

Method	Description
getForeColor()	@deprecated. Please use the ‘foreColor’ property instead. Gets and sets the fill fore color.
setForeColor(Color)	@deprecated. Please use the ‘foreColor’ property instead. Gets and sets the fill fore color.
getForeColorTransparency()	@deprecated. Please use the ‘foreColorTransparency’ property instead. Returns or sets the degree of fore color of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
setForeColorTransparency(number)	@deprecated. Please use the ‘foreColorTransparency’ property instead. Returns or sets the degree of fore color of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).
getBackColor()	@deprecated. Please use the ‘backColor’ property instead. Gets and sets the file back color.
setBackColor(Color)	@deprecated. Please use the ‘backColor’ property instead. Gets and sets the file back color.
getImageData()	@deprecated. Please use the ‘imageData’ property instead. Gets and sets the Texture and Picture fill data.
setImageData(Uint8Array)	@deprecated. Please use the ‘imageData’ property instead. Gets and sets the Texture and Picture fill data.
getTexture()	@deprecated. Please use the ’texture’ property instead. Gets the texture fill type.
isVisible()	@deprecated. Please use the ‘isVisible’ property instead. Indicates whether there is fill.
setIsVisible(boolean)	@deprecated. Please use the ‘isVisible’ property instead. Indicates whether there is fill.
setOneColorGradient(Color, number, GradientStyleType, number)	Sets the specified fill to a one-color gradient.
isNull()	Checks whether the implementation object is null.

foreColor

Gets and sets the fill fore color.

foreColor : Color;

foreColorTransparency

Returns or sets the degree of fore color of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

foreColorTransparency : number;

backColor

Gets and sets the file back color.

backColor : Color;

imageData

Gets and sets the Texture and Picture fill data.

imageData : Uint8Array;

texture

Readonly. Gets the texture fill type.

texture : TextureType;

isVisible

Indicates whether there is fill.

isVisible : boolean;

getForeColor()

@deprecated. Please use the ‘foreColor’ property instead. Gets and sets the fill fore color.

getForeColor() : Color;

Returns

Color

setForeColor(Color)

@deprecated. Please use the ‘foreColor’ property instead. Gets and sets the fill fore color.

setForeColor(value: Color) : void;

Parameters:

Parameter	Type	Description
value	Color	The value to set.

getForeColorTransparency()

@deprecated. Please use the ‘foreColorTransparency’ property instead. Returns or sets the degree of fore color of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

getForeColorTransparency() : number;

setForeColorTransparency(number)

@deprecated. Please use the ‘foreColorTransparency’ property instead. Returns or sets the degree of fore color of the specified fill as a value from 0.0 (opaque) through 1.0 (clear).

setForeColorTransparency(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getBackColor()

@deprecated. Please use the ‘backColor’ property instead. Gets and sets the file back color.

getBackColor() : Color;

Returns

Color

setBackColor(Color)

@deprecated. Please use the ‘backColor’ property instead. Gets and sets the file back color.

setBackColor(value: Color) : void;

Parameters:

Parameter	Type	Description
value	Color	The value to set.

getImageData()

@deprecated. Please use the ‘imageData’ property instead. Gets and sets the Texture and Picture fill data.

getImageData() : Uint8Array;

setImageData(Uint8Array)

@deprecated. Please use the ‘imageData’ property instead. Gets and sets the Texture and Picture fill data.

setImageData(value: Uint8Array) : void;

Parameters:

Parameter	Type	Description
value	number[]	The value to set.

getTexture()

@deprecated. Please use the ’texture’ property instead. Gets the texture fill type.

getTexture() : TextureType;

Returns

TextureType

isVisible()

@deprecated. Please use the ‘isVisible’ property instead. Indicates whether there is fill.

isVisible() : boolean;

setIsVisible(boolean)

@deprecated. Please use the ‘isVisible’ property instead. Indicates whether there is fill.

setIsVisible(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

setOneColorGradient(Color, number, GradientStyleType, number)

Sets the specified fill to a one-color gradient.

setOneColorGradient(color: Color, degree: number, style: GradientStyleType, variant: number) : void;

Parameters:

Parameter	Type	Description
color	Color	One gradient color.
degree	number	The gradient degree. Can be a value from 0.0 (dark) through 1.0 (light).
style	GradientStyleType	Gradient shading style.
variant	number	The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;