Edit

Excel.CellPropertiesFont interface

Package:
excel

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

Remarks

API set: ExcelApi 1.9

Used by

Properties

bold

Represents the format.font.bold property.
color

Represents the format.font.color property.
italic

Represents the format.font.italic property.
name

Represents the format.font.name property.
size

Represents the format.font.size property.
strikethrough

Represents the format.font.strikethrough property.
subscript

Represents the format.font.subscript property.
superscript

Represents the format.font.superscript property.
tintAndShade

Represents the format.font.tintAndShade property.
underline

Represents the format.font.underline property.

Property Details

bold

Represents the format.font.bold property.

bold?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi 1.9

color

Represents the format.font.color property.

color?: string;

Property Value

string

Remarks

API set: ExcelApi 1.9

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();

    // Create the SettableCellProperties objects for the range.
    // Create these objects once, outside the function, in your add-in.
    const topHeaderProps: Excel.SettableCellProperties = {
        // Set the style property to the name of an Excel style.
        // The `BuiltInStyle` enum lists the built-in style names.
        // A style overwrites formatting, so don't use style and format in the same object.
        style: Excel.BuiltInStyle.heading1
    };

    const headerProps: Excel.SettableCellProperties = {
        // Setting these cell properties doesn't change unspecified format subproperties.
        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
                }
            },
            horizontalAlignment: Excel.HorizontalAlignment.center
        }
    };

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

    // Use empty JSON objects to leave a cell's properties unchanged.
    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.

italic?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi 1.9

name

Represents the format.font.name property.

name?: string;

Property Value

string

Remarks

API set: ExcelApi 1.9

size

Represents the format.font.size property.

size?: number;

Property Value

number

Remarks

API set: ExcelApi 1.9

strikethrough

Represents the format.font.strikethrough property.

strikethrough?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi 1.9

subscript

Represents the format.font.subscript property.

subscript?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi 1.9

superscript

Represents the format.font.superscript property.

superscript?: boolean;

Property Value

boolean

Remarks

API set: ExcelApi 1.9

tintAndShade

Represents the format.font.tintAndShade property.

tintAndShade?: number;

Property Value

number

Remarks

API set: ExcelApi 1.9

underline

Represents the format.font.underline property.

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

Property Value

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

Remarks

API set: ExcelApi 1.9