Excel.WindowCollection class
表示 Window 对象的集合。
方法
| break |
破坏窗口的并排视图。 |
| compare |
将当前窗口与指定窗口并排比较。 |
| get |
获取集合中的窗口数。 |
| get |
按索引获取集合中的窗口。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| reset |
重置并排视图中窗口的位置。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
items
方法详细信息
breakSideBySide()
compareCurrentSideBySideWith(windowName)
将当前窗口与指定窗口并排比较。
compareCurrentSideBySideWith(windowName: string): void;参数
- windowName
-
string
返回
void
注解
getCount()
获取集合中的窗口数。
getCount(): OfficeExtension.ClientResult<number>;返回
OfficeExtension.ClientResult<number>
注解
getItemAt(index)
按索引获取集合中的窗口。
getItemAt(index: number): Excel.Window;参数
- index
-
number
返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.WindowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WindowCollection;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.WindowCollection;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.WindowCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
resetPositionsSideBySide()
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.WindowCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.WindowCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。
toJSON(): Excel.Interfaces.WindowCollectionData;