Excel.Window class

Paquete:

excel

Representa una ventana del libro.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

Propiedades

activeCell	Especifica la celda activa de la ventana.
activePane	Especifica el panel activo de la ventana.
activeWorksheet	Especifica la hoja activa en la ventana.
autoFilterDateGroupingEnabled	Especifica si la agrupación de fechas de Autofiltro está habilitada en la ventana.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
enableResize	Especifica si el cambio de tamaño está habilitado para la ventana.
freezePanes	Especifica si los paneles están inmovilizados en la ventana.
height	Especifica el alto de la ventana.
index	Obtiene el índice de la ventana.
isVisible	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.
rangeSelection	Obtiene la selección de rango en la ventana.
scrollColumn	Especifica la columna de desplazamiento de la ventana.
scrollRow	Especifica la fila de desplazamiento de la ventana.
showFormulas	Especifica si las fórmulas se muestran en la ventana.
showGridlines	Especifica si las líneas de cuadrícula se muestran en la ventana.
showHeadings	Especifica si los encabezados se muestran en la ventana.
showHorizontalScrollBar	Especifica si la barra de desplazamiento horizontal se muestra en la ventana.
showOutline	Especifica si el esquema se muestra en la ventana.
showRightToLeft	Obtiene el valor de diseño de derecha a izquierda de la ventana. True significa que la ventana usa el diseño de derecha a izquierda, false significa que la ventana usa el diseño de izquierda a derecha.
showRuler	Especifica si la regla se muestra en la ventana.
showVerticalScrollBar	Especifica si la barra de desplazamiento vertical se muestra en la ventana.
showWhitespace	Especifica si el espacio en blanco se muestra en la ventana.
showWorkbookTabs	Especifica si las pestañas del libro se muestran en la ventana.
showZeros	Especifica si se muestran ceros en la ventana.
split	Especifica el estado de división de la ventana.
splitColumn	Especifica la columna de división de la ventana.
splitHorizontal	Especifica la división horizontal de la ventana.
splitRow	Especifica la fila dividida de la ventana.
splitVertical	Especifica la división vertical de la ventana.
tabRatio	Especifica la relación de tabulación 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 la ventana.
usableHeight	Especifica el alto utilizable de la ventana.
usableWidth	Especifica el ancho utilizable de la ventana.
view	Especifica la vista de la ventana.
visibleRange	Obtiene el intervalo visible de la ventana.
width	Especifica el ancho de visualización de la ventana.
windowNumber	Obtiene el número de ventana.
windowState	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.
activateNext()	Activa la siguiente ventana.
activatePrevious()	Activa la ventana anterior.
close()	Cierra la ventana.
largeScroll(Down, Up, ToRight, ToLeft)	Desplaza la ventana por varias páginas. Los downparámetros , up, toRighty toLeft corresponden a la acción de desplazamiento con las teclas Page Down, Page Up, Alt+Page Down y Alt+Page Up en el teclado.
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.
newWindow()	Abre una nueva ventana de Excel.
pointsToScreenPixelsX(Points)	Convierte los puntos horizontales en píxeles de pantalla.
pointsToScreenPixelsY(Points)	Convierte los puntos verticales en píxeles de pantalla.
scrollIntoView(Left, Top, Width, Height, Start)	Desplaza la ventana para mostrar el intervalo especificado.
scrollWorkbookTabs(Sheets, Position)	Desplaza las pestañas del libro.
scrollWorkbookTabs(Sheets, Position)	Desplaza 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 de API del mismo tipo.
set(properties)	Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
smallScroll(Down, Up, ToRight, ToLeft)	Desplaza la ventana por varias filas o columnas. Los downparámetros , up, toRighty toLeft corresponden a la acción de desplazamiento con teclas de flecha en el teclado.
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.Window es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.WindowData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

activeCell

Especifica la celda activa de la ventana.

readonly activeCell: Excel.Range;

Valor de propiedad

Excel.Range

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

activePane

Especifica el panel activo de la ventana.

readonly activePane: Excel.Pane;

Valor de propiedad

Excel.Pane

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

activeWorksheet

Especifica la hoja activa en la ventana.

readonly activeWorksheet: Excel.Worksheet;

Valor de propiedad

Excel.Worksheet

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

autoFilterDateGroupingEnabled

Especifica si la agrupación de fechas de Autofiltro está habilitada en la ventana.

autoFilterDateGroupingEnabled: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

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

enableResize

Especifica si el cambio de tamaño está habilitado para la ventana.

readonly enableResize: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

freezePanes

Especifica si los paneles están inmovilizados en la ventana.

freezePanes: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

height

Especifica el alto de la ventana.

height: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

index

Obtiene el índice de la ventana.

readonly index: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

isVisible

Especifica si la ventana está visible.

isVisible: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

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

[ Conjunto de API: ExcelApiDesktop 1.1 ]

name

Especifica el nombre de la ventana.

name: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

panes

Obtiene una colección de paneles asociados a la ventana.

readonly panes: Excel.PaneCollection;

Valor de propiedad

Excel.PaneCollection

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

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

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

scrollColumn

Especifica la columna de desplazamiento de la ventana.

scrollColumn: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

scrollRow

Especifica la fila de desplazamiento de la ventana.

scrollRow: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

showFormulas

Especifica si las fórmulas se muestran en la ventana.

showFormulas: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

showGridlines

Especifica si las líneas de cuadrícula se muestran en la ventana.

showGridlines: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

showHeadings

Especifica si los encabezados se muestran en la ventana.

showHeadings: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

showHorizontalScrollBar

Especifica si la barra de desplazamiento horizontal se muestra en la ventana.

showHorizontalScrollBar: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

showOutline

Especifica si el esquema se muestra en la ventana.

showOutline: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

showRightToLeft

Obtiene el valor de diseño de derecha a izquierda de la ventana. True significa que la ventana usa el diseño de derecha a izquierda, false significa que la ventana usa el diseño de izquierda a derecha.

readonly showRightToLeft: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

showRuler

Especifica si la regla se muestra en la ventana.

showRuler: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

showVerticalScrollBar

Especifica si la barra de desplazamiento vertical se muestra en la ventana.

showVerticalScrollBar: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

showWhitespace

Especifica si el espacio en blanco se muestra en la ventana.

showWhitespace: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

showWorkbookTabs

Especifica si las pestañas del libro se muestran en la ventana.

showWorkbookTabs: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

showZeros

Especifica si se muestran ceros en la ventana.

showZeros: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

split

Especifica el estado de división de la ventana.

split: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

splitColumn

Especifica la columna de división de la ventana.

splitColumn: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

splitHorizontal

Especifica la división horizontal de la ventana.

splitHorizontal: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

splitRow

Especifica la fila dividida de la ventana.

splitRow: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

splitVertical

Especifica la división vertical de la ventana.

splitVertical: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

tabRatio

Especifica la relación de tabulación de la ventana.

tabRatio: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

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

[ Conjunto de API: ExcelApiDesktop 1.1 ]

type

Especifica el tipo de la ventana.

readonly type: Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook";

Valor de propiedad

Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook"

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

usableHeight

Especifica el alto utilizable de la ventana.

readonly usableHeight: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

usableWidth

Especifica el ancho utilizable de la ventana.

readonly usableWidth: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

view

Especifica la vista de la ventana.

view: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";

Valor de propiedad

Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView"

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

visibleRange

Obtiene el intervalo visible de la ventana.

readonly visibleRange: Excel.Range;

Valor de propiedad

Excel.Range

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

width

Especifica el ancho de visualización de la ventana.

width: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

windowNumber

Obtiene el número de ventana.

readonly windowNumber: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

windowState

Especifica el estado de la ventana.

windowState: Excel.WindowState | "maximized" | "minimized" | "normal";

Valor de propiedad

Excel.WindowState | "maximized" | "minimized" | "normal"

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

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

[ Conjunto de API: ExcelApiDesktop 1.1 ]

Detalles del método

activate()

Activa la ventana.

activate(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

activateNext()

Activa la siguiente ventana.

activateNext(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

activatePrevious()

Activa la ventana anterior.

activatePrevious(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

close()

Cierra la ventana.

close(): OfficeExtension.ClientResult<boolean>;

Devoluciones

OfficeExtension.ClientResult<boolean>

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

largeScroll(Down, Up, ToRight, ToLeft)

Desplaza la ventana por varias páginas. Los downparámetros , up, toRighty toLeft corresponden a la acción de desplazamiento con las teclas Page Down, Page Up, Alt+Page Down y Alt+Page Up 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

[ 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.WindowLoadOptions): Excel.Window;

Parámetros

options

Excel.Interfaces.WindowLoadOptions

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

Devoluciones

Excel.Window

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

Excel.Window

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

Excel.Window

newWindow()

Abre una nueva ventana de Excel.

newWindow(): Excel.Window;

Devoluciones

Excel.Window

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

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

[ Conjunto de API: ExcelApiDesktop 1.1 ]

pointsToScreenPixelsY(Points)

Convierte los puntos verticales en píxeles de pantalla.

pointsToScreenPixelsY(Points: number): OfficeExtension.ClientResult<number>;

Parámetros

Points

number

Devoluciones

OfficeExtension.ClientResult<number>

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

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

[ Conjunto de API: ExcelApiDesktop 1.1 ]

scrollWorkbookTabs(Sheets, Position)

Desplaza las pestañas del libro.

scrollWorkbookTabs(Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition): void;

Parámetros

Sheets

number

Position

Excel.ScrollWorkbookTabPosition

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

scrollWorkbookTabs(Sheets, Position)

Desplaza las pestañas del libro.

scrollWorkbookTabs(Sheets?: number, Position?: "First" | "Last"): void;

Parámetros

Sheets

number

Position

"First" | "Last"

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApiDesktop 1.1 ]

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 de API del mismo tipo.

set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties

Excel.Interfaces.WindowUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al 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, en función de 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. Los downparámetros , up, toRighty toLeft corresponden a la acción de desplazamiento con teclas de flecha 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

[ 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.Window es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.WindowData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.WindowData;

Devoluciones

Excel.Interfaces.WindowData