Excel.NamedSheetView class

包:

excel

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

扩展

OfficeExtension.ClientObject

注解

API 集：ExcelApiOnline 1.1

使用方

• Excel.NamedSheetViewCollection： add， enterTemporary， getActive， getItem， getItemAt， getItemOrNullObject， items

属性

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