Excel.RangeBorderCollection class

  • 参考
包:
excel

表示构成区域边框的 Border 对象。

Extends
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.1 ]

属性

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
count

集合中的 border 对象数量。
items

获取此集合中已加载的子项。
tintAndShade

指定一个使范围边框的颜色变浅或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 值 null 指示整个边框集合没有统 tintAndShade 一设置。

方法

getItem(index)

使用其名称获取 border 对象
getItem(indexString)

使用其名称获取 border 对象
getItemAt(index)

使用其索引获取 border 对象
load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.RangeBorderCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.RangeBorderCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

属性详细信息

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

count

集合中的 border 对象数量。

readonly count: number;

属性值

number

注解

[ API 集：ExcelApi 1.1 ]

items

获取此集合中已加载的子项。

readonly items: Excel.RangeBorder[];

属性值

Excel.RangeBorder[]

tintAndShade

指定一个使范围边框的颜色变浅或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 值 null 指示整个边框集合没有统 tintAndShade 一设置。

tintAndShade: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

方法详细信息

getItem(index)

使用其名称获取 border 对象

getItem(index: Excel.BorderIndex): Excel.RangeBorder;

参数

index
Excel.BorderIndex

要检索的 border 对象的索引值。 有关详细信息，请参阅 Excel.BorderIndex。

返回

Excel.RangeBorder

注解

[ API 集：ExcelApi 1.1 ]

示例

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)

使用其名称获取 border 对象

getItem(indexString: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"): Excel.RangeBorder;

参数

indexString

"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"

要检索的 border 对象的索引值。 有关详细信息，请参阅 Excel.BorderIndex。

返回

Excel.RangeBorder

注解

[ API 集：ExcelApi 1.1 ]

getItemAt(index)

使用其索引获取 border 对象

getItemAt(index: number): Excel.RangeBorder;

参数

index

number

要检索的对象的索引值。 从零开始编制索引。

返回

Excel.RangeBorder

注解

[ API 集：ExcelApi 1.1 ]

示例

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;

参数

options

Excel.Interfaces.RangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

提供要加载对象的属性的选项。

返回

Excel.RangeBorderCollection

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Excel.RangeBorderCollection;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Excel.RangeBorderCollection

示例

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 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.RangeBorderCollection

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.RangeBorderCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.RangeBorderCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

toJSON(): Excel.Interfaces.RangeBorderCollectionData;

返回

Excel.Interfaces.RangeBorderCollectionData