Excel.RangeBorderCollection class
Represents the border objects that make up the range border.
- Extends
Remarks
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| count | Number of border objects in the collection. |
| items | Gets the loaded child items in this collection. |
Methods
| get |
Gets a border object using its name. |
| get |
Gets a border object using its name. |
| get |
Gets a border object using its index. |
| 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 |
| toJSON() | Overrides the JavaScript |
Property Details
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
count
Number of border objects in the collection.
readonly count: number;Property Value
number
Remarks
items
Gets the loaded child items in this collection.
readonly items: Excel.RangeBorder[];Property Value
Method Details
getItem(index)
Gets a border object using its name.
getItem(index: Excel.BorderIndex): Excel.RangeBorder;Parameters
- index
- Excel.BorderIndex
Index value of the border object to be retrieved. See Excel.BorderIndex for details.
Returns
Remarks
Examples
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
const border = range.format.borders.getItem(Excel.BorderIndex.edgeTop);
border.load('style');
await context.sync();
console.log(border.style);
});
getItem(indexString)
Gets a border object using its name.
getItem(indexString: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"): Excel.RangeBorder;Parameters
- indexString
-
"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"
Index value of the border object to be retrieved. See Excel.BorderIndex for details.
Returns
Remarks
getItemAt(index)
Gets a border object using its index.
getItemAt(index: number): Excel.RangeBorder;Parameters
- index
-
number
Index value of the object to be retrieved. Zero-indexed.
Returns
Remarks
Examples
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
const border = range.format.borders.getItemAt(0);
border.load('sideIndex');
await context.sync();
console.log(border.sideIndex);
});
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.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeBorderCollection;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.RangeBorderCollection;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
Examples
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
const borders = range.format.borders;
borders.load('items');
await context.sync();
console.log(borders.count);
for (let i = 0; i < borders.items.length; i++) {
console.log(borders.items[i].sideIndex);
}
});
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?: OfficeExtension.LoadOption): Excel.RangeBorderCollection;Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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.RangeBorderCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.RangeBorderCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Excel.Interfaces.RangeBorderCollectionData;Returns
Office Add-ins