Edit

Share via

Excel.CellPropertiesFont interface

  • Reference
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 ]

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

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

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 ]