Excel.ShapeFill class

Represents the fill formatting of a shape object.

[ API set: ExcelApi 1.9 ]

Extends
OfficeExtension.ClientObject

Properties

context

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

foregroundColor

Represents the shape fill foreground color in HTML color format, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange")

[ API set: ExcelApi 1.9 ]

transparency

Returns or sets 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.

[ API set: ExcelApi 1.9 ]

type

Returns the fill type of the shape. Read-only. See Excel.ShapeFillType for details.

[ API set: ExcelApi 1.9 ]

Methods

clear()

Clears the fill formatting of this shape.

[ API set: ExcelApi 1.9 ]

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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)

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

setSolidColor(color)

Sets the fill formatting of the shape to a uniform color. This changes the fill type to "Solid".

[ API set: ExcelApi 1.9 ]

toJSON()

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 is passed to it.) Whereas the original Excel.ShapeFill object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeFillData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

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

foregroundColor

Represents the shape fill foreground color in HTML color format, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange")

[ API set: ExcelApi 1.9 ]

foregroundColor: string;

Property Value

string

transparency

Returns or sets 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.

[ API set: ExcelApi 1.9 ]

transparency: number;

Property Value

number

type

Returns the fill type of the shape. Read-only. See Excel.ShapeFillType for details.

[ API set: ExcelApi 1.9 ]

readonly type: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed";

Property Value

Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed"

Method Details

clear()

Clears the fill formatting of this shape.

[ API set: ExcelApi 1.9 ]

clear(): void;

Returns

void

load(options)

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

load(options?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill;

Parameters

options
Excel.Interfaces.ShapeFillLoadOptions

Provides options for which properties of the object to load.

Returns

load(propertyNames)

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[]): Excel.ShapeFill;

Parameters

propertyNames
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

load(propertyNamesAndPaths)

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;
        }): Excel.ShapeFill;

Parameters

propertyNamesAndPaths
{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

set(properties, options)

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.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Interfaces.ShapeFillUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

Remarks

This method has the following additional signature:

set(properties: Excel.ShapeFill): void

set(properties)

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

set(properties: Excel.ShapeFill): void;

Parameters

properties
Excel.ShapeFill

Returns

void

setSolidColor(color)

Sets the fill formatting of the shape to a uniform color. This changes the fill type to "Solid".

[ API set: ExcelApi 1.9 ]

setSolidColor(color: string): void;

Parameters

color
string

A string that represents the fill color in HTML color format, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").

Returns

void

toJSON()

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 is passed to it.) Whereas the original Excel.ShapeFill object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeFillData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ShapeFillData;

Returns