Excel.ConditionalRangeBorderCollection class

包:

excel

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

Extends

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.6 ]

属性

bottom	获取下边框。
context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
count	集合中的 border 对象数量。
items	获取此集合中已加载的子项。
left	获取左边框。
right	获取右边框。
top	获取上边框。

方法

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.ConditionalRangeBorderCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ConditionalRangeBorderCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

属性详细信息

bottom

获取下边框。

readonly bottom: Excel.ConditionalRangeBorder;

属性值

Excel.ConditionalRangeBorder

注解

[ API 集：ExcelApi 1.6 ]

context

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

context: RequestContext;

属性值

Excel.RequestContext

count

集合中的 border 对象数量。

readonly count: number;

属性值

number

注解

[ API 集：ExcelApi 1.6 ]

items

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

readonly items: Excel.ConditionalRangeBorder[];

属性值

Excel.ConditionalRangeBorder[]

left

获取左边框。

readonly left: Excel.ConditionalRangeBorder;

属性值

Excel.ConditionalRangeBorder

注解

[ API 集：ExcelApi 1.6 ]

right

获取右边框。

readonly right: Excel.ConditionalRangeBorder;

属性值

Excel.ConditionalRangeBorder

注解

[ API 集：ExcelApi 1.6 ]

top

获取上边框。

readonly top: Excel.ConditionalRangeBorder;

属性值

Excel.ConditionalRangeBorder

注解

[ API 集：ExcelApi 1.6 ]

方法详细信息

getItem(index)

使用其名称获取 border 对象

getItem(index: Excel.ConditionalRangeBorderIndex): Excel.ConditionalRangeBorder;

参数

index

Excel.ConditionalRangeBorderIndex

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

返回

Excel.ConditionalRangeBorder

注解

[ API 集：ExcelApi 1.6 ]

getItem(indexString)

使用其名称获取 border 对象

getItem(indexString: "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"): Excel.ConditionalRangeBorder;

参数

indexString

"EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight"

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

返回

Excel.ConditionalRangeBorder

注解

[ API 集：ExcelApi 1.6 ]

getItemAt(index)

使用其索引获取 border 对象

getItemAt(index: number): Excel.ConditionalRangeBorder;

参数

index

number

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

返回

Excel.ConditionalRangeBorder

注解

[ API 集：ExcelApi 1.6 ]

load(options)

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

load(options?: Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalRangeBorderCollection;

参数

options

Excel.Interfaces.ConditionalRangeBorderCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

返回

Excel.ConditionalRangeBorderCollection

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.ConditionalRangeBorderCollection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ConditionalRangeBorderCollection;

参数

propertyNamesAndPaths

OfficeExtension.LoadOption

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

返回

Excel.ConditionalRangeBorderCollection

toJSON()

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

toJSON(): Excel.Interfaces.ConditionalRangeBorderCollectionData;

返回

Excel.Interfaces.ConditionalRangeBorderCollectionData