Excel.RangeFormat class
A format object encapsulating the range's font, fill, borders, alignment, and other properties.
- Extends
Remarks
Properties
| borders | Collection of border objects that apply to the overall range. |
| 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 |
| vertical |
Represents the vertical alignment for the specified object. See |
| wrap |
Specifies if Excel wraps the text in the object. A |
Methods
| 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
borders
Collection of border objects that apply to the overall range.
readonly borders: Excel.RangeBorderCollection;Property Value
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
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
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's 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;