Excel.RangeBorderCollection class
表示构成区域边框的 Border 对象。
属性
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| count | 集合中的 border 对象数量。 |
| items | 获取此集合中已加载的子项。 |
| tint |
指定使区域边框的颜色变亮或变暗的双精度。 该值介于 -1 (最暗) 和 1 (最亮) 之间，其中 0 表示原始颜色。 值 |
方法
| get |
使用其名称获取 border 对象 |
| get |
使用其名称获取 border 对象 |
| get |
使用其索引获取 border 对象 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
count
items
tintAndShade
指定使区域边框的颜色变亮或变暗的双精度。 该值介于 -1 (最暗) 和 1 (最亮) 之间，其中 0 表示原始颜色。 值 null 指示整个边框集合没有统一 tintAndShade 的设置。
tintAndShade: number;属性值
number
注解
方法详细信息
getItem(index)
使用其名称获取 border 对象
getItem(index: Excel.BorderIndex): Excel.RangeBorder;参数
- index
- Excel.BorderIndex
要检索的 border 对象的索引值。 有关详细信息，请参阅 Excel.BorderIndex。
返回
注解
示例
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(index)
使用其名称获取 border 对象
getItem(index: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"): Excel.RangeBorder;参数
- index
-
"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"
要检索的 border 对象的索引值。 有关详细信息，请参阅 Excel.BorderIndex。
返回
注解
getItemAt(index)
使用其索引获取 border 对象
getItemAt(index: number): Excel.RangeBorder;参数
- index
-
number
要检索的对象的索引值。 从零开始编制索引。
返回
注解
示例
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)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.RangeBorderCollection;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.RangeBorderCollection;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
示例
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)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.RangeBorderCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.RangeBorderCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.RangeBorderCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。
toJSON(): Excel.Interfaces.RangeBorderCollectionData;