Excel.RangeFill class

HTML color code representing the color of the background, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange")

[ API set: ExcelApi 1.1 ]

color: string;

Property Value

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

Gets or sets the pattern of a Range. See Excel.FillPattern for details. LinearGradient and RectangularGradient are not supported. A null value indicates that the entire range doesn't have uniform pattern setting.

[ API set: ExcelApi 1.9 ]

pattern: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient";

Property Value

Sets HTML color code representing the color of the Range pattern, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). Gets HTML color code representing the color of the Range pattern, of the form #RRGGBB (e.g. "FFA500").

[ API set: ExcelApi 1.9 ]

patternColor: string;

Property Value

Returns or sets a double that lightens or darkens a pattern color for Range Fill, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color. If the pattern tintAndShades are not uniform, null will be returned.

[ API set: ExcelApi 1.9 ]

patternTintAndShade: number;

Property Value

Returns or sets a double that lightens or darkens a color for Range Fill, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color. If the tintAndShades are not uniform, null will be returned.

[ API set: ExcelApi 1.9 ]

tintAndShade: number;

Property Value

Resets the range background.

[ API set: ExcelApi 1.1 ]

clear(): void;

Returns

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F:G";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    var rangeFill = range.format.fill;
    rangeFill.clear();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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.RangeFillLoadOptions): Excel.RangeFill;

Parameters

Returns

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.RangeFill;

Parameters

Returns

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F:G";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    var rangeFill = range.format.fill;
    rangeFill.load('color');
    return ctx.sync().then(function() {
        console.log(rangeFill.color);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

// The example below sets fill color. 
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F:G";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.format.fill.color = '0000FF';
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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.RangeFill;

Parameters

Returns

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

Parameters

Returns

Remarks

This method has the following additional signature:

set(properties: Excel.RangeFill): void

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

set(properties: Excel.RangeFill): void;

Parameters

Returns

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

toJSON(): Excel.Interfaces.RangeFillData;

Returns