Excel.CellPropertiesFont interface

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

[ API set: ExcelApi 1.9 ]

Properties

bold

Represents the format.font.bold property.

[ API set: ExcelApi 1.9 ]

color

Represents the format.font.color property.

[ API set: ExcelApi 1.9 ]

italic

Represents the format.font.italic property.

[ API set: ExcelApi 1.9 ]

name

Represents the format.font.name property.

[ API set: ExcelApi 1.9 ]

size

Represents the format.font.size property.

[ API set: ExcelApi 1.9 ]

strikethrough

Represents the format.font.strikethrough property.

[ API set: ExcelApi 1.9 ]

subscript

Represents the format.font.subscript property.

[ API set: ExcelApi 1.9 ]

superscript

Represents the format.font.superscript property.

[ API set: ExcelApi 1.9 ]

tintAndShade

Represents the format.font.tintAndShade property.

[ API set: ExcelApi 1.9 ]

underline

Represents the format.font.underline property.

[ API set: ExcelApi 1.9 ]

Property Details

bold

Represents the format.font.bold property.

[ API set: ExcelApi 1.9 ]

bold?: boolean;

Property Value

boolean

color

Represents the format.font.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();
});

italic

Represents the format.font.italic property.

[ API set: ExcelApi 1.9 ]

italic?: boolean;

Property Value

boolean

name

Represents the format.font.name property.

[ API set: ExcelApi 1.9 ]

name?: string;

Property Value

string

size

Represents the format.font.size property.

[ API set: ExcelApi 1.9 ]

size?: number;

Property Value

number

strikethrough

Represents the format.font.strikethrough property.

[ API set: ExcelApi 1.9 ]

strikethrough?: boolean;

Property Value

boolean

subscript

Represents the format.font.subscript property.

[ API set: ExcelApi 1.9 ]

subscript?: boolean;

Property Value

boolean

superscript

Represents the format.font.superscript property.

[ API set: ExcelApi 1.9 ]

superscript?: boolean;

Property Value

boolean

tintAndShade

Represents the format.font.tintAndShade property.

[ API set: ExcelApi 1.9 ]

tintAndShade?: number;

Property Value

number

underline

Represents the format.font.underline property.

[ API set: ExcelApi 1.9 ]

underline?: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant";

Property Value

Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"