MsoFillFormatHelper
MsoFillFormatHelper class
Represents fill formatting for a shape.
class MsoFillFormatHelper;
Methods
| Method | Description |
|---|---|
| getForeColor() | Gets and sets the fill fore color. |
| setForeColor(Color) | Gets and sets the fill fore color. |
| getForeColorTransparency() | 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) | Returns or sets the degree of fore color of the specified fill as a value from 0.0 (opaque) through 1.0 (clear). |
| getBackColor() | Gets and sets the file back color. |
| setBackColor(Color) | Gets and sets the file back color. |
| getImageData() | Gets and sets the Texture and Picture fill data. |
| setImageData(number[]) | Gets and sets the Texture and Picture fill data. |
| getTexture() | Gets the texture fill type. |
| isVisible() | Indicates whether there is fill. |
| setIsVisible(boolean) | 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. |
getForeColor()
Gets and sets the fill fore color.
getForeColor() : Color;
Returns
setForeColor(Color)
Gets and sets the fill fore color.
setForeColor(value: Color) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The value to set. |
getForeColorTransparency()
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)
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()
Gets and sets the file back color.
getBackColor() : Color;
Returns
setBackColor(Color)
Gets and sets the file back color.
setBackColor(value: Color) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Color | The value to set. |
getImageData()
Gets and sets the Texture and Picture fill data.
getImageData() : number[];
Returns
number[]
setImageData(number[])
Gets and sets the Texture and Picture fill data.
setImageData(value: number[]) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number[] | The value to set. |
getTexture()
Gets the texture fill type.
getTexture() : TextureType;
Returns
isVisible()
Indicates whether there is fill.
isVisible() : boolean;
setIsVisible(boolean)
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;