Edit

Share via

Excel.RangeFormat class

  • Reference
Package:
excel

A format object encapsulating the range's font, fill, borders, alignment, and other properties.

Extends
OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.1 ]

Properties

borders

Collection of border objects that apply to the overall range.
columnWidth

Specifies the width of all columns within the range. If the column widths are not uniform, null will be returned.
context

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

Returns the fill object defined on the overall range.
font

Returns the font object defined on the overall range.
horizontalAlignment

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

Returns the format protection object for a range.
rowHeight

The height of all rows in the range. If the row heights are not uniform, null will be returned.
textOrientation

The text orientation of all the cells within the range. The text orientation should be an integer either from -90 to 90, or 180 for vertically-oriented text. If the orientation within a range are not uniform, then null will be returned.
useStandardHeight

Determines if the row height of the Range object equals the standard height of the sheet. Returns true if the row height of the Range object equals the standard height of the sheet. Returns null if the range contains more than one row and the rows aren't all the same height. Returns false otherwise. Note: This property is only intended to be set to true. Setting it to false has no effect.
useStandardWidth

Specifies if the column width of the Range object equals the standard width of the sheet. Returns true if the column width of the Range object equals the standard width of the sheet. Returns null if the range contains more than one column and the columns aren't all the same height. Returns false otherwise. Note: This property is only intended to be set to true. Setting it to false has no effect.
verticalAlignment

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

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

Methods

autofitColumns()

Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.
autofitRows()

Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.
load(options)

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

Property Details

borders

Collection of border objects that apply to the overall range.

readonly borders: Excel.RangeBorderCollection;

Property Value

Excel.RangeBorderCollection

Remarks

[ API set: ExcelApi 1.1 ]

columnWidth

Specifies the width of all columns within the range. If the column widths are not uniform, null will be returned.

columnWidth: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.2 ]

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

Excel.RequestContext

fill

Returns the fill object defined on the overall range.

readonly fill: Excel.RangeFill;

Property Value

Excel.RangeFill

Remarks

[ API set: ExcelApi 1.1 ]

font

Returns the font object defined on the overall range.

readonly font: Excel.RangeFont;

Property Value

Excel.RangeFont

Remarks

[ API set: ExcelApi 1.1 ]

horizontalAlignment

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

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

Remarks

[ API set: ExcelApi 1.1 ]

protection

Returns the format protection object for a range.

readonly protection: Excel.FormatProtection;

Property Value

Excel.FormatProtection

Remarks

[ API set: ExcelApi 1.2 ]

rowHeight

The height of all rows in the range. If the row heights are not uniform, null will be returned.

rowHeight: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.2 ]

textOrientation

The text orientation of all the cells within the range. The text orientation should be an integer either from -90 to 90, or 180 for vertically-oriented text. If the orientation within a range are not uniform, then null will be returned.

textOrientation: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

Examples

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:E2");

    // Set textOrientation to either an integer between -90 and 90
    // or to 180 for vertically-oriented text.
    range.format.textOrientation = 90;

    await context.sync();
});

useStandardHeight

Determines if the row height of the Range object equals the standard height of the sheet. Returns true if the row height of the Range object equals the standard height of the sheet. Returns null if the range contains more than one row and the rows aren't all the same height. Returns false otherwise. Note: This property is only intended to be set to true. Setting it to false has no effect.

useStandardHeight: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

useStandardWidth

Specifies if the column width of the Range object equals the standard width of the sheet. Returns true if the column width of the Range object equals the standard width of the sheet. Returns null if the range contains more than one column and the columns aren't all the same height. Returns false otherwise. Note: This property is only intended to be set to true. Setting it to false has no effect.

useStandardWidth: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

verticalAlignment

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

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

Property Value

Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"

Remarks

[ API set: ExcelApi 1.1 ]

wrapText

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

boolean

Remarks

[ API set: ExcelApi 1.1 ]

Method Details

autofitColumns()

Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.

autofitColumns(): void;

Returns

void

Remarks

[ API set: ExcelApi 1.2 ]

autofitRows()

Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.

autofitRows(): void;

Returns

void

Remarks

[ API set: ExcelApi 1.2 ]

load(options)

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

options
Excel.Interfaces.RangeFormatLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.RangeFormat

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

Parameters

propertyNames

string | string[]

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

Returns

Excel.RangeFormat

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

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

Parameters

propertyNamesAndPaths

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

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

Excel.RangeFormat

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

Parameters

properties
Excel.Interfaces.RangeFormatUpdateData

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

set(properties)

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

set(properties: Excel.RangeFormat): void;

Parameters

properties
Excel.RangeFormat

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

Excel.Interfaces.RangeFormatData