Excel.NamedSheetView class

包:

excel

表示工作表的命名工作表视图。 工作表视图存储特定工作表的排序和筛选规则。 每个工作表视图 (甚至临时工作表视图) 都具有用于访问视图的唯一工作表范围名称。

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApiOnline 1.1 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
name	获取或设置工作表视图的名称。 临时工作表视图名称是空字符串 (“”) 。 使用 name 属性命名视图会导致保存工作表视图。

方法

activate()	激活此工作表视图。 这相当于在 Excel UI 中使用“切换到”。
delete()	从工作表中删除工作表视图。
duplicate(name)	创建此工作表视图的副本。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.NamedSheetView对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.NamedSheetViewData) ，其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

name

获取或设置工作表视图的名称。 临时工作表视图名称是空字符串 (“”) 。 使用 name 属性命名视图会导致保存工作表视图。

name: string;

属性值

string

注解

[ API 集：ExcelApiOnline 1.1 ]

方法详细信息

activate()

激活此工作表视图。 这相当于在 Excel UI 中使用“切换到”。

activate(): void;

返回

void

注解

[ API 集：ExcelApiOnline 1.1 ]

delete()

从工作表中删除工作表视图。

delete(): void;

返回

void

注解

[ API 集：ExcelApiOnline 1.1 ]

duplicate(name)

创建此工作表视图的副本。

duplicate(name?: string): Excel.NamedSheetView;

参数

name

string

重复的工作表视图的名称。 如果未提供名称，则将生成一个名称。

返回

Excel.NamedSheetView

新的重复工作表视图。

注解

[ API 集：ExcelApiOnline 1.1 ]

load(options)

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

load(options?: Excel.Interfaces.NamedSheetViewLoadOptions): Excel.NamedSheetView;

参数

options

Excel.Interfaces.NamedSheetViewLoadOptions

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

返回

Excel.NamedSheetView

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.NamedSheetView

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.NamedSheetView

toJSON()

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

toJSON(): Excel.Interfaces.NamedSheetViewData;

返回

Excel.Interfaces.NamedSheetViewData