Excel.RangeFont class

This object represents the font attributes (font name, font size, color, etc.) for an object.

[ API set: ExcelApi 1.1 ]

Extends
OfficeExtension.ClientObject

Properties

bold

Represents the bold status of font.

[ API set: ExcelApi 1.1 ]

color

HTML color code representation of the text color. E.g. #FF0000 represents Red.

[ API set: ExcelApi 1.1 ]

italic

Represents the italic status of the font.

[ API set: ExcelApi 1.1 ]

name

Font name (e.g. "Calibri")

[ API set: ExcelApi 1.1 ]

size

Font size.

[ API set: ExcelApi 1.1 ]

underline

Type of underline applied to the font. See Excel.RangeUnderlineStyle for details.

[ API set: ExcelApi 1.1 ]

Methods

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

toJSON()

Property Details

bold

Represents the bold status of font.

[ API set: ExcelApi 1.1 ]

bold: boolean;
Property Value
boolean

color

HTML color code representation of the text color. E.g. #FF0000 represents Red.

[ API set: ExcelApi 1.1 ]

color: string;
Property Value
string

italic

Represents the italic status of the font.

[ API set: ExcelApi 1.1 ]

italic: boolean;
Property Value
boolean

name

Font name (e.g. "Calibri")

[ API set: ExcelApi 1.1 ]

name: string;
Property Value
string

size

Font size.

[ API set: ExcelApi 1.1 ]

size: number;
Property Value
number

underline

Type of underline applied to the font. See Excel.RangeUnderlineStyle for details.

[ API set: ExcelApi 1.1 ]

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

Method Details

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: string | string[]): Excel.RangeFont;
Parameters
option
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns
Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Excel.RangeFont - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.RangeFont - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

Examples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F:G";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    var rangeFont = range.format.font;
    rangeFont.load('name');
    return ctx.sync().then(function() {
        console.log(rangeFont.name);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
// The example below sets font name. 
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "F:G";
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.format.font.name = 'Times New Roman';
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

toJSON()

toJSON(): Excel.Interfaces.RangeFontData;
Returns