Excel.CellPropertiesFill interface

Represents the format.fill properties of getCellProperties, getRowProperties, and getColumnProperties or the format.fill input parameter of setCellProperties, setRowProperties, and setColumnProperties.

[ API set: ExcelApi 1.9 ]

Properties

color

Represents the format.fill.color property.

[ API set: ExcelApi 1.9 ]

pattern

Represents the format.fill.pattern property.

[ API set: ExcelApi 1.9 ]

patternColor

Represents the format.fill.patternColor property.

[ API set: ExcelApi 1.9 ]

patternTintAndShade

Represents the format.fill.patternTintAndShade property.

[ API set: ExcelApi 1.9 ]

tintAndShade

Represents the format.fill.tintAndShade property.

[ API set: ExcelApi 1.9 ]

Property Details

color

Represents the format.fill.color property.

[ API set: ExcelApi 1.9 ]

color?: string;

Property Value

string

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Creating the SettableCellProperties objects to use for the range.
    // In your add-in, these should be created once, outside the function.
    const topHeaderProps: Excel.SettableCellProperties = {
        // The style property takes a string matching the name of an Excel style.
        // Note that a style will overwrite any formatting,
        // so do not use the format property with the style property.
        style: "Heading1"
    };

    const headerProps: Excel.SettableCellProperties = {
        // Any subproperties of format that are not set will not be changed when these cell properties are set.
        format: {
            fill: {
                color: "Blue"
            },
            font: {
                color: "White",
                bold: true
            }
        }
    };

    const nonApplicableProps: Excel.SettableCellProperties = {
        format: {
            fill: {
                pattern: Excel.FillPattern.gray25
            },
            font: {
                color: "Gray",
                italic: true
            }
        }
    };

    const matchupScoreProps: Excel.SettableCellProperties = {
        format: {
            borders: {
                bottom: {
                    style: Excel.BorderLineStyle.continuous
                },
                left: {
                    style: Excel.BorderLineStyle.continuous
                },
                right: {
                    style: Excel.BorderLineStyle.continuous
                },
                top: {
                    style: Excel.BorderLineStyle.continuous
                }
            }
        }
    };

    const range = sheet.getRange("A1:E5");

    // You can use empty JSON objects to avoid changing a cell's properties.
    range.setCellProperties([
        [topHeaderProps, {}, {}, {}, {}],
        [{}, {}, headerProps, headerProps, headerProps],
        [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps],
        [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps]
    ]);

    sheet.getUsedRange().format.autofitColumns();
    await context.sync();
});

pattern

Represents the format.fill.pattern property.

[ 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

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

patternColor

Represents the format.fill.patternColor property.

[ API set: ExcelApi 1.9 ]

patternColor?: string;

Property Value

string

patternTintAndShade

Represents the format.fill.patternTintAndShade property.

[ API set: ExcelApi 1.9 ]

patternTintAndShade?: number;

Property Value

number

tintAndShade

Represents the format.fill.tintAndShade property.

[ API set: ExcelApi 1.9 ]

tintAndShade?: number;

Property Value

number