Excel.RangeFormat class
A format object encapsulating the range's font, fill, borders, alignment, and other properties.
- Extends
Remarks
Properties
| auto |
Specifies if text is automatically indented when text alignment is set to equal distribution. |
| borders | Collection of border objects that apply to the overall range. |
| column |
Specifies the width of all columns within the range. If the column widths are not uniform, |
| 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. |
| horizontal |
Represents the horizontal alignment for the specified object. See |
| indent |
An integer from 0 to 250 that indicates the indent level. |
| protection | Returns the format protection object for a range. |
| reading |
The reading order for the range. |
| row |
The height of all rows in the range. If the row heights are not uniform, |
| shrink |
Specifies if text automatically shrinks to fit in the available column width. |
| text |
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 |
| use |
Determines if the row height of the |
| use |
Specifies if the column width of the |
| vertical |
Represents the vertical alignment for the specified object. See |
| wrap |
Specifies if Excel wraps the text in the object. A |
Methods
| adjust |
Adjusts the indentation of the range formatting. The indent value ranges from 0 to 250 and is measured in characters. |
| autofit |
Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. |
| autofit |
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 |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| 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 |
Property Details
autoIndent
Specifies if text is automatically indented when text alignment is set to equal distribution.
autoIndent: boolean;Property Value
boolean
Remarks
borders
Collection of border objects that apply to the overall range.
readonly borders: Excel.RangeBorderCollection;Property Value
Remarks
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
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
fill
Returns the fill object defined on the overall range.
readonly fill: Excel.RangeFill;Property Value
Remarks
font
Returns the font object defined on the overall range.
readonly font: Excel.RangeFont;Property Value
Remarks
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
indentLevel
An integer from 0 to 250 that indicates the indent level.
indentLevel: number;Property Value
number
Remarks
protection
Returns the format protection object for a range.
readonly protection: Excel.FormatProtection;Property Value
Remarks
readingOrder
The reading order for the range.
readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";Property Value
Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"
Remarks
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
shrinkToFit
Specifies if text automatically shrinks to fit in the available column width.
shrinkToFit: boolean;Property Value
boolean
Remarks
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
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
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
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
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
Method Details
adjustIndent(amount)
Adjusts the indentation of the range formatting. The indent value ranges from 0 to 250 and is measured in characters.
adjustIndent(amount: number): void;Parameters
- amount
-
number
The number of character spaces by which the current indent is adjusted. This value should be between -250 and 250. Note: If the amount would raise the indent level above 250, the indent level stays with 250. Similarly, if the amount would lower the indent level below 0, the indent level stays 0.
Returns
void
Remarks
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
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
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
Provides options for which properties of the object to load.
Returns
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
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
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
Office Add-ins