Excel.NamedSheetViewCollection class
表示工作表中工作表视图的集合。
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| items | 获取此集合中已加载的子项。 |
方法
| add(name) | 创建具有给定名称的新工作表视图。 |
| enter |
创建并激活新的临时工作表视图。 关闭应用程序、使用 exit 方法退出临时视图或切换到另一个工作表视图时，将删除临时视图。 如果临时视图存在，也可以使用空字符串 (“”) 访问临时工作表视图。 |
| exit() | 退出当前活动的工作表视图。 |
| get |
获取工作表的当前活动工作表视图。 |
| get |
获取此工作表中的工作表视图数。 包括临时工作表视图（如果存在）。 |
| get |
使用其名称获取工作表视图。 |
| get |
按其集合中的索引获取工作表视图。 |
| get |
使用其名称获取工作表视图。 如果工作表视图对象不存在，则此方法返回一个对象，其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 重写 JavaScript |
属性详细信息
context
items
方法详细信息
add(name)
创建具有给定名称的新工作表视图。
add(name: string): Excel.NamedSheetView;参数
- name
-
string
要创建的工作表视图的名称。 如果提供的名称已存在、为空或是工作表保留的名称，则引发错误。
返回
新建的工作表视图对象。
注解
enterTemporary()
创建并激活新的临时工作表视图。 关闭应用程序、使用 exit 方法退出临时视图或切换到另一个工作表视图时，将删除临时视图。 如果临时视图存在，也可以使用空字符串 (“”) 访问临时工作表视图。
enterTemporary(): Excel.NamedSheetView;返回
新建的工作表视图对象。
注解
exit()
getActive()
获取工作表的当前活动工作表视图。
getActive(): Excel.NamedSheetView;返回
此工作表的当前活动工作表视图。
注解
getCount()
获取此工作表中的工作表视图数。 包括临时工作表视图（如果存在）。
getCount(): OfficeExtension.ClientResult<number>;返回
OfficeExtension.ClientResult<number>
注解
getItem(key)
使用其名称获取工作表视图。
getItem(key: string): Excel.NamedSheetView;参数
- key
-
string
工作表视图的区分大小写的名称。 如果临时视图存在，请使用空字符串 (“”) 获取临时工作表视图。
返回
具有给定名称的工作表视图;如果提供了空字符串，则为临时视图。 如果没有当前临时视图，并且提供了空字符串，则会 ItemNotFound 引发错误。
注解
getItemAt(index)
按其集合中的索引获取工作表视图。
getItemAt(index: number): Excel.NamedSheetView;参数
- index
-
number
集合中工作表视图对象的索引。
返回
给定索引处的工作表视图。
注解
getItemOrNullObject(key)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
使用其名称获取工作表视图。 如果工作表视图对象不存在，则此方法返回一个对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(key: string): Excel.NamedSheetView;参数
- key
-
string
工作表视图的区分大小写的名称。 如果临时视图存在，请使用空字符串 (“”) 获取临时工作表视图。
返回
具有给定名称的工作表视图;如果提供了空字符串，则为临时视图。
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedSheetViewCollection;参数
- options
-
Excel.Interfaces.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.NamedSheetViewCollection;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NamedSheetViewCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始Excel.NamedSheetViewCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.NamedSheetViewCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。
toJSON(): Excel.Interfaces.NamedSheetViewCollectionData;