Excel.WindowCollection class

Paquete:

excel

Representa una colección de objetos Window.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
items	Obtiene los elementos secundarios cargados en esta colección.

Métodos

breakSideBySide()	Interrumpe la vista en paralelo de las ventanas.
compareCurrentSideBySideWith(windowName)	Compara la ventana actual en paralelo con la ventana especificada.
getCount()	Obtiene el número de ventanas de la colección.
getItemAt(index)	Obtiene la ventana de la colección por índice.
load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
resetPositionsSideBySide()	Restablece las posiciones de las ventanas en la vista en paralelo.
toJSON()	Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.WindowCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.WindowCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

Detalles de las propiedades

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Excel.Window[];

Valor de propiedad

Excel.Window[]

Detalles del método

breakSideBySide()

Interrumpe la vista en paralelo de las ventanas.

breakSideBySide(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

compareCurrentSideBySideWith(windowName)

Compara la ventana actual en paralelo con la ventana especificada.

compareCurrentSideBySideWith(windowName: string): void;

Parámetros

windowName

string

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

getCount()

Obtiene el número de ventanas de la colección.

getCount(): OfficeExtension.ClientResult<number>;

Devoluciones

OfficeExtension.ClientResult<number>

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

getItemAt(index)

Obtiene la ventana de la colección por índice.

getItemAt(index: number): Excel.Window;

Parámetros

index

number

Devoluciones

Excel.Window

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.WindowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WindowCollection;

Parámetros

options

Excel.Interfaces.WindowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.WindowCollection

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.WindowCollection

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.WindowCollection;

Parámetros

propertyNamesAndPaths

OfficeExtension.LoadOption

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.WindowCollection

resetPositionsSideBySide()

Restablece las posiciones de las ventanas en la vista en paralelo.

resetPositionsSideBySide(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.WindowCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.WindowCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): Excel.Interfaces.WindowCollectionData;

Devoluciones

Excel.Interfaces.WindowCollectionData