Excel.TableStyleCollection class

包:

excel

表示表格样式的集合。

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.10 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
items	获取此集合中已加载的子项。

方法

add(name, makeUniqueName)	创建具有指定名称的空白 TableStyle 。
getCount()	获取集合中表格样式的数量。
getDefault()	获取父对象的作用域的默认表样式。
getItem(name)	TableStyle按名称获取 。
getItemOrNullObject(name)	TableStyle按名称获取 。 如果表样式不存在，则此方法返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
setDefault(newDefaultStyle)	设置在父对象的作用域中使用的默认表样式。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.TableStyleCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.TableStyleCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

items

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

readonly items: Excel.TableStyle[];

属性值

Excel.TableStyle[]

方法详细信息

add(name, makeUniqueName)

创建具有指定名称的空白 TableStyle 。

add(name: string, makeUniqueName?: boolean): Excel.TableStyle;

参数

name

string

新表格样式的唯一名称。 如果名称已在使用中，将引发 InvalidArgument 错误。

makeUniqueName

boolean

可选。 默认为 false。 如果 true为 ，则会在名称中追加数字，以便在需要时使其唯一。

返回

Excel.TableStyle

新创建的 TableStyle。

注解

[ API 集：ExcelApi 1.10 ]

getCount()

获取集合中表格样式的数量。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

注解

[ API 集：ExcelApi 1.10 ]

getDefault()

获取父对象的作用域的默认表样式。

getDefault(): Excel.TableStyle;

返回

Excel.TableStyle

当前 TableStyle 默认表样式的对象。

注解

[ API 集：ExcelApi 1.10 ]

getItem(name)

TableStyle按名称获取 。

getItem(name: string): Excel.TableStyle;

参数

name

string

要检索的表样式的名称。

返回

Excel.TableStyle

TableStyle名称与输入匹配的对象。

注解

[ API 集：ExcelApi 1.10 ]

getItemOrNullObject(name)

TableStyle按名称获取 。 如果表样式不存在，则此方法返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。

getItemOrNullObject(name: string): Excel.TableStyle;

参数

name

string

要检索的表样式的名称。

返回

Excel.TableStyle

TableStyle名称与输入匹配的对象。

注解

[ API 集：ExcelApi 1.10 ]

load(options)

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

load(options?: Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableStyleCollection;

参数

options

Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

返回

Excel.TableStyleCollection

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.TableStyleCollection

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

OfficeExtension.LoadOption

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

返回

Excel.TableStyleCollection

setDefault(newDefaultStyle)

设置在父对象的作用域中使用的默认表样式。

setDefault(newDefaultStyle: TableStyle | string): void;

参数

newDefaultStyle

Excel.TableStyle | string

应 TableStyle 为新默认值的对象 TableStyle 或对象的名称。

返回

void

注解

[ API 集：ExcelApi 1.10 ]

toJSON()

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

toJSON(): Excel.Interfaces.TableStyleCollectionData;

返回

Excel.Interfaces.TableStyleCollectionData