Excel.RangeFormat class

Collection of border objects that apply to the overall range.

readonly borders: Excel.RangeBorderCollection;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

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

Returns the fill object defined on the overall range.

readonly fill: Excel.RangeFill;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

Returns the font object defined on the overall range.

readonly font: Excel.RangeFont;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

Represents the horizontal alignment for the specified object. See Excel.HorizontalAlignment for details.

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

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

Represents the vertical alignment for the specified object. See Excel.VerticalAlignment for details.

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

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

Specifies if Excel wraps the text in the object. A null value indicates that the entire range doesn't have a uniform wrap setting

wrapText: boolean;

Property Value

Remarks

[ API set: ExcelApi 1.1 ]

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.RangeFormatLoadOptions): Excel.RangeFormat;

Parameters

Returns

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

Parameters

Returns

Examples

// Select all of the range's format properties.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load(["format/*", "format/fill", "format/borders", "format/font"]);
    await context.sync();
    
    console.log(range.format.wrapText);
    console.log(range.format.fill.color);
    console.log(range.format.font.name);
});

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

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

toJSON(): Excel.Interfaces.RangeFormatData;

Returns