Excel.Style class

A collection of four border objects that represent the style of the four borders.

readonly borders: Excel.RangeBorderCollection;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Specifies if the style is a built-in style.

readonly builtIn: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

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

The fill of the style.

readonly fill: Excel.RangeFill;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

A Font object that represents the font of the style.

readonly font: Excel.RangeFont;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let style = context.workbook.styles.getItem("Normal");
    style.font.load("bold, color, italic, name, size");
    style.fill.load("color");

    await context.sync();

    console.log("Bold: " + style.font.bold);
    console.log("Font color: " + style.font.color);
    console.log("Italic: " + style.font.italic);
    console.log("Name: " + style.font.name);
    console.log("Size: " + style.font.size);
    console.log("Fill color: " + style.fill.color);
});

Specifies if the formula will be hidden when the worksheet is protected.

formulaHidden: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Represents the horizontal alignment for the style. See Excel.HorizontalAlignment for details.

horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let worksheet = context.workbook.worksheets.getItem("Sample");
    let range = worksheet.getRange("A1:E1");

    // Apply built-in style. 
    // Styles are in the Home tab ribbon.
    range.style = Excel.BuiltInStyle.neutral;
    range.format.horizontalAlignment = "Right";

    await context.sync();
});

Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties.

includeAlignment: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Specifies if the style includes the color, color index, line style, and weight border properties.

includeBorder: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties.

includeFont: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Specifies if the style includes the number format property.

includeNumber: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties.

includePatterns: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Specifies if the style includes the formula hidden and locked protection properties.

includeProtection: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

An integer from 0 to 250 that indicates the indent level for the style.

indentLevel: number;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Specifies if the object is locked when the worksheet is protected.

locked: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

The name of the style.

readonly name: string;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

The format code of the number format for the style.

numberFormat: string;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

The localized format code of the number format for the style.

numberFormatLocal: string;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

The reading order for the style.

readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Specifies if text automatically shrinks to fit in the available column width.

shrinkToFit: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Specifies the vertical alignment for the style. See Excel.VerticalAlignment for details.

verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Specifies if Excel wraps the text in the object.

wrapText: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.7 ]

Deletes this style.

delete(): void;

Returns

Remarks

[ API set: ExcelApi 1.7 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let style = context.workbook.styles.getItem("Diagonal Orientation Style");

    // Delete the diagonal orientation style from the style collection.
    // Styles are in the Home tab ribbon.
    style.delete();

    await context.sync();

    console.log("Successfully deleted the diagonal orientation style from the Home tab ribbon.");
});

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

load(options?: Excel.Interfaces.StyleLoadOptions): Excel.Style;

Parameters

Returns

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let style = context.workbook.styles.getItem("Diagonal Orientation Style");            
    style.load("textOrientation, horizontalAlignment, autoIndent, readingOrder, wrapText, includeProtection, shrinkToFit, locked");

    await context.sync();

    console.log("Orientation: " + style.textOrientation);
    console.log("Horizontal alignment: " + style.horizontalAlignment);
    console.log("Add indent: " + style.autoIndent);
    console.log("Reading order: " + style.readingOrder);
    console.log("Wrap text: " + style.wrapText);
    console.log("Include protection: " + style.includeProtection);
    console.log("Shrink to fit: " + style.shrinkToFit);
    console.log("Style locked: " + style.locked);
});

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.Style;

Parameters

Returns

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.Style;

Parameters

Returns

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.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

Returns

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

set(properties: Excel.Style): void;

Parameters

Returns

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.Style object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.StyleData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.StyleData;

Returns