Excel.Window class
Representa una ventana del libro.
- Extends
Propiedades
| active |
Especifica la celda activa en la ventana. |
| active |
Especifica el panel activo de la ventana. |
| active |
Especifica la hoja activa de la ventana. |
| auto |
Especifica si la agrupación de fechas Autofiltro está habilitada en la ventana. |
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| enable |
Especifica si está habilitado el cambio de tamaño para la ventana. |
| freeze |
Especifica si los paneles están inmovilizados en la ventana. |
| height | Especifica la altura de la ventana. |
| index | Obtiene el índice de la ventana. |
| is |
Especifica si la ventana está visible. |
| left | Especifica la distancia, en puntos, desde el borde izquierdo de la pantalla del equipo hasta el borde izquierdo de la ventana. |
| name | Especifica el nombre de la ventana. |
| panes | Obtiene una colección de paneles asociados a la ventana. |
| range |
Obtiene la selección de rango en la ventana. |
| scroll |
Especifica la columna de desplazamiento de la ventana. |
| scroll |
Especifica la fila de desplazamiento de la ventana. |
| show |
Especifica si las fórmulas se muestran en la ventana. |
| show |
Especifica si las líneas de cuadrícula se muestran en la ventana. |
| show |
Especifica si se muestran los títulos en la ventana. |
| show |
Especifica si la barra de desplazamiento horizontal se muestra en la ventana. |
| show |
Especifica si se muestra el esquema en la ventana. |
| show |
Obtiene el valor de diseño de la ventana de derecha a izquierda. Verdadero significa que la ventana usa el diseño de derecha a izquierda, falso significa que la ventana usa el diseño de izquierda a derecha. |
| show |
Especifica si la regla se muestra en la ventana. |
| show |
Especifica si la barra de desplazamiento vertical se muestra en la ventana. |
| show |
Especifica si se muestra el espacio en blanco en la ventana. |
| show |
Especifica si se muestran pestañas de libro en la ventana. |
| show |
Especifica si se muestran ceros en la ventana. |
| split | Especifica el estado de división de la ventana. |
| split |
Especifica la columna dividida de la ventana. |
| split |
Especifica la división horizontal de la ventana. |
| split |
Especifica la fila dividida de la ventana. |
| split |
Especifica la división vertical de la ventana. |
| tab |
Especifica la proporción de tabulaciones de la ventana. |
| top | Especifica la distancia, en puntos, desde el borde superior de la ventana hasta el borde superior del área utilizable (debajo de los menús, las barras de herramientas acopladas en la parte superior y la barra de fórmulas). |
| type | Especifica el tipo de ventana. |
| usable |
Especifica la altura utilizable de la ventana. |
| usable |
Especifica el ancho que se puede usar de la ventana. |
| view | Especifica la vista de la ventana. |
| visible |
Obtiene el rango visible de la ventana. |
| width | Especifica el ancho de visualización de la ventana. |
| window |
Obtiene el número de la ventana. |
| window |
Especifica el estado de la ventana. |
| zoom | Especifica un valor entero que representa el tamaño de visualización de la ventana. Se puede establecer en un porcentaje entre 10 y 400. |
Métodos
| activate() | Activa la ventana. |
| activate |
Activa la siguiente ventana. |
| activate |
Activa la ventana anterior. |
| close() | Cierra la ventana. |
| large |
Desplaza la ventana varias páginas.
|
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| new |
Se abre una nueva ventana de Excel. |
| points |
Convierte los puntos horizontales en píxeles de pantalla. |
| points |
Convierte puntos verticales en píxeles de pantalla. |
| scroll |
Desplaza la ventana para mostrar el intervalo especificado. |
| scroll |
Se desplaza por las pestañas del libro. |
| scroll |
Se desplaza por las pestañas del libro. |
| set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente. |
| small |
Desplaza la ventana por varias filas o columnas.
|
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
activeCell
Especifica la celda activa en la ventana.
readonly activeCell: Excel.Range;Valor de propiedad
Comentarios
activePane
Especifica el panel activo de la ventana.
readonly activePane: Excel.Pane;Valor de propiedad
Comentarios
activeWorksheet
Especifica la hoja activa de la ventana.
readonly activeWorksheet: Excel.Worksheet;Valor de propiedad
Comentarios
autoFilterDateGroupingEnabled
Especifica si la agrupación de fechas Autofiltro está habilitada en la ventana.
autoFilterDateGroupingEnabled: boolean;Valor de propiedad
boolean
Comentarios
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
enableResize
Especifica si está habilitado el cambio de tamaño para la ventana.
readonly enableResize: boolean;Valor de propiedad
boolean
Comentarios
freezePanes
Especifica si los paneles están inmovilizados en la ventana.
freezePanes: boolean;Valor de propiedad
boolean
Comentarios
height
Especifica la altura de la ventana.
height: number;Valor de propiedad
number
Comentarios
index
Obtiene el índice de la ventana.
readonly index: number;Valor de propiedad
number
Comentarios
isVisible
Especifica si la ventana está visible.
isVisible: boolean;Valor de propiedad
boolean
Comentarios
left
Especifica la distancia, en puntos, desde el borde izquierdo de la pantalla del equipo hasta el borde izquierdo de la ventana.
left: number;Valor de propiedad
number
Comentarios
name
Especifica el nombre de la ventana.
name: string;Valor de propiedad
string
Comentarios
panes
Obtiene una colección de paneles asociados a la ventana.
readonly panes: Excel.PaneCollection;Valor de propiedad
Comentarios
rangeSelection
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Obtiene la selección de rango en la ventana.
readonly rangeSelection: Excel.RangeAreas;Valor de propiedad
Comentarios
scrollColumn
Especifica la columna de desplazamiento de la ventana.
scrollColumn: number;Valor de propiedad
number
Comentarios
scrollRow
Especifica la fila de desplazamiento de la ventana.
scrollRow: number;Valor de propiedad
number
Comentarios
showFormulas
Especifica si las fórmulas se muestran en la ventana.
showFormulas: boolean;Valor de propiedad
boolean
Comentarios
showGridlines
Especifica si las líneas de cuadrícula se muestran en la ventana.
showGridlines: boolean;Valor de propiedad
boolean
Comentarios
showHeadings
Especifica si se muestran los títulos en la ventana.
showHeadings: boolean;Valor de propiedad
boolean
Comentarios
showHorizontalScrollBar
Especifica si la barra de desplazamiento horizontal se muestra en la ventana.
showHorizontalScrollBar: boolean;Valor de propiedad
boolean
Comentarios
showOutline
Especifica si se muestra el esquema en la ventana.
showOutline: boolean;Valor de propiedad
boolean
Comentarios
showRightToLeft
Obtiene el valor de diseño de la ventana de derecha a izquierda. Verdadero significa que la ventana usa el diseño de derecha a izquierda, falso significa que la ventana usa el diseño de izquierda a derecha.
readonly showRightToLeft: boolean;Valor de propiedad
boolean
Comentarios
showRuler
Especifica si la regla se muestra en la ventana.
showRuler: boolean;Valor de propiedad
boolean
Comentarios
showVerticalScrollBar
Especifica si la barra de desplazamiento vertical se muestra en la ventana.
showVerticalScrollBar: boolean;Valor de propiedad
boolean
Comentarios
showWhitespace
Especifica si se muestra el espacio en blanco en la ventana.
showWhitespace: boolean;Valor de propiedad
boolean
Comentarios
showWorkbookTabs
Especifica si se muestran pestañas de libro en la ventana.
showWorkbookTabs: boolean;Valor de propiedad
boolean
Comentarios
showZeros
Especifica si se muestran ceros en la ventana.
showZeros: boolean;Valor de propiedad
boolean
Comentarios
split
Especifica el estado de división de la ventana.
split: boolean;Valor de propiedad
boolean
Comentarios
splitColumn
Especifica la columna dividida de la ventana.
splitColumn: number;Valor de propiedad
number
Comentarios
splitHorizontal
Especifica la división horizontal de la ventana.
splitHorizontal: number;Valor de propiedad
number
Comentarios
splitRow
Especifica la fila dividida de la ventana.
splitRow: number;Valor de propiedad
number
Comentarios
splitVertical
Especifica la división vertical de la ventana.
splitVertical: number;Valor de propiedad
number
Comentarios
tabRatio
Especifica la proporción de tabulaciones de la ventana.
tabRatio: number;Valor de propiedad
number
Comentarios
top
Especifica la distancia, en puntos, desde el borde superior de la ventana hasta el borde superior del área utilizable (debajo de los menús, las barras de herramientas acopladas en la parte superior y la barra de fórmulas).
top: number;Valor de propiedad
number
Comentarios
type
Especifica el tipo de ventana.
readonly type: Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook";Valor de propiedad
Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook"
Comentarios
usableHeight
Especifica la altura utilizable de la ventana.
readonly usableHeight: number;Valor de propiedad
number
Comentarios
usableWidth
Especifica el ancho que se puede usar de la ventana.
readonly usableWidth: number;Valor de propiedad
number
Comentarios
view
Especifica la vista de la ventana.
view: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";Valor de propiedad
Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView"
Comentarios
visibleRange
Obtiene el rango visible de la ventana.
readonly visibleRange: Excel.Range;Valor de propiedad
Comentarios
width
Especifica el ancho de visualización de la ventana.
width: number;Valor de propiedad
number
Comentarios
windowNumber
Obtiene el número de la ventana.
readonly windowNumber: number;Valor de propiedad
number
Comentarios
windowState
Especifica el estado de la ventana.
windowState: Excel.WindowState | "maximized" | "minimized" | "normal";Valor de propiedad
Excel.WindowState | "maximized" | "minimized" | "normal"
Comentarios
zoom
Especifica un valor entero que representa el tamaño de visualización de la ventana. Se puede establecer en un porcentaje entre 10 y 400.
zoom: number;Valor de propiedad
number
Comentarios
Detalles del método
activate()
Activa la ventana.
activate(): void;Devoluciones
void
Comentarios
activateNext()
Activa la siguiente ventana.
activateNext(): void;Devoluciones
void
Comentarios
activatePrevious()
Activa la ventana anterior.
activatePrevious(): void;Devoluciones
void
Comentarios
close()
Cierra la ventana.
close(): OfficeExtension.ClientResult<boolean>;Devoluciones
OfficeExtension.ClientResult<boolean>
Comentarios
largeScroll(Down, Up, ToRight, ToLeft)
Desplaza la ventana varias páginas.
toRight
up, , down, y toLeft los parámetros corresponden a la acción de desplazarse con las teclas Av Pág, Re Pág, Alt + Av Pág y Alt + Av Pág en el teclado.
largeScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;Parámetros
- Down
-
number
- Up
-
number
- ToRight
-
number
- ToLeft
-
number
Devoluciones
void
Comentarios
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.WindowLoadOptions): Excel.Window;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
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.Window;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
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?: {
select?: string;
expand?: string;
}): Excel.Window;Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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
newWindow()
Se abre una nueva ventana de Excel.
newWindow(): Excel.Window;Devoluciones
Comentarios
pointsToScreenPixelsX(Points)
Convierte los puntos horizontales en píxeles de pantalla.
pointsToScreenPixelsX(Points: number): OfficeExtension.ClientResult<number>;Parámetros
- Points
-
number
Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
pointsToScreenPixelsY(Points)
Convierte puntos verticales en píxeles de pantalla.
pointsToScreenPixelsY(Points: number): OfficeExtension.ClientResult<number>;Parámetros
- Points
-
number
Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
scrollIntoView(Left, Top, Width, Height, Start)
Desplaza la ventana para mostrar el intervalo especificado.
scrollIntoView(Left: number, Top: number, Width: number, Height: number, Start?: boolean): void;Parámetros
- Left
-
number
- Top
-
number
- Width
-
number
- Height
-
number
- Start
-
boolean
Devoluciones
void
Comentarios
scrollWorkbookTabs(Sheets, Position)
Se desplaza por las pestañas del libro.
scrollWorkbookTabs(Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition): void;Parámetros
- Sheets
-
number
- Position
- Excel.ScrollWorkbookTabPosition
Devoluciones
void
Comentarios
scrollWorkbookTabs(Sheets, Position)
Se desplaza por las pestañas del libro.
scrollWorkbookTabs(Sheets?: number, Position?: "First" | "Last"): void;Parámetros
- Sheets
-
number
- Position
-
"First" | "Last"
Devoluciones
void
Comentarios
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.
set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.WindowUpdateData
Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.
set(properties: Excel.Window): void;Parámetros
- properties
- Excel.Window
Devoluciones
void
smallScroll(Down, Up, ToRight, ToLeft)
Desplaza la ventana por varias filas o columnas.
toRight
up, , down, y toLeft los parámetros corresponden a la acción de desplazarse con las teclas de dirección en el teclado.
smallScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;Parámetros
- Down
-
number
- Up
-
number
- ToRight
-
number
- ToLeft
-
number
Devoluciones
void
Comentarios
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.Window es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.WindowData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.WindowData;