Excel.WindowCollection class
Represents a collection of Window objects.
- Extends
Remarks
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| items | Gets the loaded child items in this collection. |
Methods
| break |
Breaks the side-by-side view of windows. |
| compare |
Compares the current window side by side with the specified window. |
| get |
Gets the number of windows in the collection. |
| get |
Gets the Window in the collection by index. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| reset |
Resets the positions of windows in side-by-side view. |
| toJSON() | Overrides the JavaScript |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
items
Gets the loaded child items in this collection.
readonly items: Excel.Window[];Property Value
Method Details
breakSideBySide()
Breaks the side-by-side view of windows.
breakSideBySide(): void;Returns
void
Remarks
compareCurrentSideBySideWith(windowName)
Compares the current window side by side with the specified window.
compareCurrentSideBySideWith(windowName: string): void;Parameters
- windowName
-
string
Returns
void
Remarks
getCount()
Gets the number of windows in the collection.
getCount(): OfficeExtension.ClientResult<number>;Returns
OfficeExtension.ClientResult<number>
Remarks
getItemAt(index)
Gets the Window in the collection by index.
getItemAt(index: number): Excel.Window;Parameters
- index
-
number
Returns
Remarks
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Excel.Interfaces.WindowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WindowCollection;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.WindowCollection;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.WindowCollection;Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
resetPositionsSideBySide()
Resets the positions of windows in side-by-side view.
resetPositionsSideBySide(): void;Returns
void
Remarks
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.WindowCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WindowCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Excel.Interfaces.WindowCollectionData;