Excel.RangeBorder class

代表对象的边框。

扩展

注解

[ API 集:ExcelApi 1.1 ]

属性

color

表示边框线颜色的 HTML 颜色代码,形式 #RRGGBB (例如“FFA500”) ,或作为命名的 HTML 颜色 (例如“橙色”) 。

context

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

sideIndex

指示边框的特定边的常量值。 有关详细信息,请参阅 Excel.BorderIndex

style

线条样式的常量之一,指定边框的线条样式。 有关详细信息,请参阅 Excel.BorderLineStyle

tintAndShade

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

weight

指定区域周围的边框的粗细。 有关详细信息,请参阅 Excel.BorderWeight

方法

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.RangeBorder对象是 API 对象,toJSON该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.RangeBorderData) ,其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

color

表示边框线颜色的 HTML 颜色代码,形式 #RRGGBB (例如“FFA500”) ,或作为命名的 HTML 颜色 (例如“橙色”) 。

color: string;

属性值

string

注解

[ API 集:ExcelApi 1.1 ]

context

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

context: RequestContext;

属性值

sideIndex

指示边框的特定边的常量值。 有关详细信息,请参阅 Excel.BorderIndex

readonly sideIndex: Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp";

属性值

Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"

注解

[ API 集:ExcelApi 1.1 ]

style

线条样式的常量之一,指定边框的线条样式。 有关详细信息,请参阅 Excel.BorderLineStyle

style: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot";

属性值

Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot"

注解

[ API 集:ExcelApi 1.1 ]

示例

// Add grid borders around the range.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    range.format.borders.getItem('InsideHorizontal').style = 'Continuous';
    range.format.borders.getItem('InsideVertical').style = 'Continuous';
    range.format.borders.getItem('EdgeBottom').style = 'Continuous';
    range.format.borders.getItem('EdgeLeft').style = 'Continuous';
    range.format.borders.getItem('EdgeRight').style = 'Continuous';
    range.format.borders.getItem('EdgeTop').style = 'Continuous';
    await context.sync(); 
});

tintAndShade

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

tintAndShade: number;

属性值

number

注解

[ API 集:ExcelApi 1.9 ]

weight

指定区域周围的边框的粗细。 有关详细信息,请参阅 Excel.BorderWeight

weight: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick";

属性值

Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"

注解

[ API 集:ExcelApi 1.1 ]

方法详细信息

load(options)

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

load(options?: Excel.Interfaces.RangeBorderLoadOptions): Excel.RangeBorder;

参数

options
Excel.Interfaces.RangeBorderLoadOptions

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

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.RangeBorder;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand 一个逗号分隔的字符串,指定要加载的导航属性。

返回

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.RangeBorderUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties
Excel.Interfaces.RangeBorderUpdateData

一个 JavaScript 对象,其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

set(properties: Excel.RangeBorder): void;

参数

properties
Excel.RangeBorder

返回

void

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.RangeBorder对象是 API 对象,toJSON该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.RangeBorderData) ,其中包含原始对象中任何已加载子属性的浅表副本。

toJSON(): Excel.Interfaces.RangeBorderData;

返回