Excel.RangeFont class

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

[ API set: ExcelApi 1.1 ]

Extends

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 ]

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

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 ]

strikethrough

Represents the strikethrough status of font. A null value indicates that the entire range doesn't have uniform Strikethrough setting.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

subscript

Represents the Subscript status of font. Returns True if all the fonts of the range are Subscript. Returns False if all the fonts of the range are Superscript or normal (neither Superscript, nor Subscript). Returns Null otherwise.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

superscript

Represents the Superscript status of font. Returns True if all the fonts of the range are Superscript. Returns False if all the fonts of the range are Subscript or normal (neither Superscript, nor Subscript). Returns Null otherwise.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

tintAndShade

Returns or sets a double that lightens or darkens a color for Range Font, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the entire range doesn't have uniform font tintAndShade setting.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.RangeFont object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.RangeFontData) that contains shallow copies of any loaded child properties from the original object.

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

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

RequestContext

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

strikethrough

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the strikethrough status of font. A null value indicates that the entire range doesn't have uniform Strikethrough setting.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

strikethrough: boolean;

Property Value

boolean

subscript

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the Subscript status of font. Returns True if all the fonts of the range are Subscript. Returns False if all the fonts of the range are Superscript or normal (neither Superscript, nor Subscript). Returns Null otherwise.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

subscript: boolean;

Property Value

boolean

superscript

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the Superscript status of font. Returns True if all the fonts of the range are Superscript. Returns False if all the fonts of the range are Subscript or normal (neither Superscript, nor Subscript). Returns Null otherwise.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

superscript: boolean;

Property Value

boolean

tintAndShade

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Returns or sets a double that lightens or darkens a color for Range Font, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color. A null value indicates that the entire range doesn't have uniform font tintAndShade setting.

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

tintAndShade: 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?: Excel.Interfaces.RangeFontLoadOptions): Excel.RangeFont;

Parameters

Returns

Remarks

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

load(option?: string | string[]): Excel.RangeFont - Where option is a comma-delimited string or an array of strings that specify the properties to load.

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.

load(propertyNames)

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

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

Parameters

propertyNames
string | string[]

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

Returns

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

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.RangeFont;

Parameters

propertyNamesAndPaths
{ select?: string; expand?: string; }

Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.RangeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties
Interfaces.RangeFontUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

Remarks

This method has the following additional signature:

set(properties: Excel.RangeFont): void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.RangeFont): void;

Parameters

properties
Excel.RangeFont

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.RangeFont object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.RangeFontData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.RangeFontData;

Returns