Edit

Share via

Excel.BuiltInStyle enum

  • Reference
Package:
excel

Remarks

[ API set: ExcelApi 1.7 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml

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.
        // Built-in style names are listed in the `BuiltInStyle` enum.
        // 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();
});

Fields

accent1 = "Accent1"
accent1_20 = "Accent1_20"
accent1_40 = "Accent1_40"
accent1_60 = "Accent1_60"
accent2 = "Accent2"
accent2_20 = "Accent2_20"
accent2_40 = "Accent2_40"
accent2_60 = "Accent2_60"
accent3 = "Accent3"
accent3_20 = "Accent3_20"
accent3_40 = "Accent3_40"
accent3_60 = "Accent3_60"
accent4 = "Accent4"
accent4_20 = "Accent4_20"
accent4_40 = "Accent4_40"
accent4_60 = "Accent4_60"
accent5 = "Accent5"
accent5_20 = "Accent5_20"
accent5_40 = "Accent5_40"
accent5_60 = "Accent5_60"
accent6 = "Accent6"
accent6_20 = "Accent6_20"
accent6_40 = "Accent6_40"
accent6_60 = "Accent6_60"
bad = "Bad"
calculation = "Calculation"
checkCell = "CheckCell"
comma = "Comma"
currency = "Currency"
emphasis1 = "Emphasis1"
emphasis2 = "Emphasis2"
emphasis3 = "Emphasis3"
explanatoryText = "ExplanatoryText"
good = "Good"
heading1 = "Heading1"
heading2 = "Heading2"
heading3 = "Heading3"
heading4 = "Heading4"
hlink = "Hlink"
hlinkTrav = "HlinkTrav"
input = "Input"
linkedCell = "LinkedCell"
neutral = "Neutral"
normal = "Normal"
note = "Note"
output = "Output"
percent = "Percent"
sheetTitle = "SheetTitle"
total = "Total"
warningText = "WarningText"
wholeComma = "WholeComma"
wholeDollar = "WholeDollar"