Excel.Window class
Representa uma janela na pasta de trabalho.
- Extends
Propriedades
| active |
Especifica a célula ativa na janela. |
| active |
Especifica o painel ativo na janela. |
| active |
Especifica a planilha ativa na janela. |
| auto |
Especifica se o agrupamento de datas de Filtro Automático está habilitado na janela. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| enable |
Especifica se o redimensionamento está habilitado para a janela. |
| freeze |
Especifica se os painéis estão congelados na janela. |
| height | Especifica a altura da janela. |
| index | Obtém o índice da janela. |
| is |
Especifica se a janela está visível. |
| left | Especifica a distância, em pontos, da borda esquerda da tela do computador até a borda esquerda da janela. |
| name | Especifica o nome da janela. |
| panes | Obtém uma coleção de painéis associados à janela. |
| range |
Obtém a seleção de intervalo na janela. |
| scroll |
Especifica a coluna de rolagem da janela. |
| scroll |
Especifica a linha de rolagem da janela. |
| show |
Especifica se as fórmulas são mostradas na janela. |
| show |
Especifica se as linhas de grade são mostradas na janela. |
| show |
Especifica se os títulos são mostrados na janela. |
| show |
Especifica se a barra de rolagem horizontal é mostrada na janela. |
| show |
Especifica se o contorno é mostrado na janela. |
| show |
Obtém o valor de layout da direita para a esquerda da janela. Verdadeiro significa que a janela está usando o layout da direita para a esquerda, falso significa que a janela está usando o layout da esquerda para a direita. |
| show |
Especifica se a régua é mostrada na janela. |
| show |
Especifica se a barra de rolagem vertical é mostrada na janela. |
| show |
Especifica se um espaço em branco é mostrado na janela. |
| show |
Especifica se as guias da pasta de trabalho são mostradas na janela. |
| show |
Especifica se zeros são mostrados na janela. |
| split | Especifica o estado de divisão da janela. |
| split |
Especifica a coluna dividida da janela. |
| split |
Especifica a divisão horizontal da janela. |
| split |
Especifica a linha de divisão da janela. |
| split |
Especifica a divisão vertical da janela. |
| tab |
Especifica a proporção de guias da janela. |
| top | Especifica a distância, em pontos, da borda superior da janela até a borda superior da área utilizável (abaixo dos menus, qualquer barra de ferramentas encaixada na parte superior e a barra de fórmulas). |
| type | Especifica o tipo da janela. |
| usable |
Especifica a altura utilizável da janela. |
| usable |
Especifica a largura utilizável da janela. |
| view | Especifica o modo de exibição da janela. |
| visible |
Obtém o intervalo visível da janela. |
| width | Especifica a largura de exibição da janela. |
| window |
Obtém o número da janela. |
| window |
Especifica o estado da janela. |
| zoom | Especifica um valor inteiro que representa o tamanho de exibição da janela. Pode ser definido como uma porcentagem entre 10 e 400. |
Métodos
| activate() | Ativa a janela. |
| activate |
Ativa a próxima janela. |
| activate |
Ativa a janela anterior. |
| close() | Fecha a janela. |
| large |
Rola a janela por várias páginas. Os |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| new |
Abre uma nova janela do Excel. |
| points |
converte pontos horizontais em pixels da tela. |
| points |
converte pontos verticais em pixels da tela. |
| scroll |
Rola a janela para exibir o intervalo especificado. |
| scroll |
Rola as guias da pasta de trabalho. |
| scroll |
Rola as guias da pasta de trabalho. |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| small |
Rola a janela por um número de linhas ou colunas. Os |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
activeCell
Especifica a célula ativa na janela.
readonly activeCell: Excel.Range;Valor da propriedade
Comentários
activePane
Especifica o painel ativo na janela.
readonly activePane: Excel.Pane;Valor da propriedade
Comentários
activeWorksheet
Especifica a planilha ativa na janela.
readonly activeWorksheet: Excel.Worksheet;Valor da propriedade
Comentários
autoFilterDateGroupingEnabled
Especifica se o agrupamento de datas de Filtro Automático está habilitado na janela.
autoFilterDateGroupingEnabled: boolean;Valor da propriedade
boolean
Comentários
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
enableResize
Especifica se o redimensionamento está habilitado para a janela.
readonly enableResize: boolean;Valor da propriedade
boolean
Comentários
freezePanes
Especifica se os painéis estão congelados na janela.
freezePanes: boolean;Valor da propriedade
boolean
Comentários
height
Especifica a altura da janela.
height: number;Valor da propriedade
number
Comentários
index
Obtém o índice da janela.
readonly index: number;Valor da propriedade
number
Comentários
isVisible
Especifica se a janela está visível.
isVisible: boolean;Valor da propriedade
boolean
Comentários
left
Especifica a distância, em pontos, da borda esquerda da tela do computador até a borda esquerda da janela.
left: number;Valor da propriedade
number
Comentários
name
Especifica o nome da janela.
name: string;Valor da propriedade
string
Comentários
panes
Obtém uma coleção de painéis associados à janela.
readonly panes: Excel.PaneCollection;Valor da propriedade
Comentários
rangeSelection
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Obtém a seleção de intervalo na janela.
readonly rangeSelection: Excel.RangeAreas;Valor da propriedade
Comentários
scrollColumn
Especifica a coluna de rolagem da janela.
scrollColumn: number;Valor da propriedade
number
Comentários
scrollRow
Especifica a linha de rolagem da janela.
scrollRow: number;Valor da propriedade
number
Comentários
showFormulas
Especifica se as fórmulas são mostradas na janela.
showFormulas: boolean;Valor da propriedade
boolean
Comentários
showGridlines
Especifica se as linhas de grade são mostradas na janela.
showGridlines: boolean;Valor da propriedade
boolean
Comentários
showHeadings
Especifica se os títulos são mostrados na janela.
showHeadings: boolean;Valor da propriedade
boolean
Comentários
showHorizontalScrollBar
Especifica se a barra de rolagem horizontal é mostrada na janela.
showHorizontalScrollBar: boolean;Valor da propriedade
boolean
Comentários
showOutline
Especifica se o contorno é mostrado na janela.
showOutline: boolean;Valor da propriedade
boolean
Comentários
showRightToLeft
Obtém o valor de layout da direita para a esquerda da janela. Verdadeiro significa que a janela está usando o layout da direita para a esquerda, falso significa que a janela está usando o layout da esquerda para a direita.
readonly showRightToLeft: boolean;Valor da propriedade
boolean
Comentários
showRuler
Especifica se a régua é mostrada na janela.
showRuler: boolean;Valor da propriedade
boolean
Comentários
showVerticalScrollBar
Especifica se a barra de rolagem vertical é mostrada na janela.
showVerticalScrollBar: boolean;Valor da propriedade
boolean
Comentários
showWhitespace
Especifica se um espaço em branco é mostrado na janela.
showWhitespace: boolean;Valor da propriedade
boolean
Comentários
showWorkbookTabs
Especifica se as guias da pasta de trabalho são mostradas na janela.
showWorkbookTabs: boolean;Valor da propriedade
boolean
Comentários
showZeros
Especifica se zeros são mostrados na janela.
showZeros: boolean;Valor da propriedade
boolean
Comentários
split
Especifica o estado de divisão da janela.
split: boolean;Valor da propriedade
boolean
Comentários
splitColumn
Especifica a coluna dividida da janela.
splitColumn: number;Valor da propriedade
number
Comentários
splitHorizontal
Especifica a divisão horizontal da janela.
splitHorizontal: number;Valor da propriedade
number
Comentários
splitRow
Especifica a linha de divisão da janela.
splitRow: number;Valor da propriedade
number
Comentários
splitVertical
Especifica a divisão vertical da janela.
splitVertical: number;Valor da propriedade
number
Comentários
tabRatio
Especifica a proporção de guias da janela.
tabRatio: number;Valor da propriedade
number
Comentários
top
Especifica a distância, em pontos, da borda superior da janela até a borda superior da área utilizável (abaixo dos menus, qualquer barra de ferramentas encaixada na parte superior e a barra de fórmulas).
top: number;Valor da propriedade
number
Comentários
type
Especifica o tipo da janela.
readonly type: Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook";Valor da propriedade
Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook"
Comentários
usableHeight
Especifica a altura utilizável da janela.
readonly usableHeight: number;Valor da propriedade
number
Comentários
usableWidth
Especifica a largura utilizável da janela.
readonly usableWidth: number;Valor da propriedade
number
Comentários
view
Especifica o modo de exibição da janela.
view: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";Valor da propriedade
Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView"
Comentários
visibleRange
Obtém o intervalo visível da janela.
readonly visibleRange: Excel.Range;Valor da propriedade
Comentários
width
Especifica a largura de exibição da janela.
width: number;Valor da propriedade
number
Comentários
windowNumber
Obtém o número da janela.
readonly windowNumber: number;Valor da propriedade
number
Comentários
windowState
Especifica o estado da janela.
windowState: Excel.WindowState | "maximized" | "minimized" | "normal";Valor da propriedade
Excel.WindowState | "maximized" | "minimized" | "normal"
Comentários
zoom
Especifica um valor inteiro que representa o tamanho de exibição da janela. Pode ser definido como uma porcentagem entre 10 e 400.
zoom: number;Valor da propriedade
number
Comentários
Detalhes do método
activate()
activateNext()
Ativa a próxima janela.
activateNext(): void;Retornos
void
Comentários
activatePrevious()
Ativa a janela anterior.
activatePrevious(): void;Retornos
void
Comentários
close()
Fecha a janela.
close(): OfficeExtension.ClientResult<boolean>;Retornos
OfficeExtension.ClientResult<boolean>
Comentários
largeScroll(Down, Up, ToRight, ToLeft)
Rola a janela por várias páginas. Os downparâmetros , up, toRighte toLeft correspondem à ação de rolar com as teclas Page Down, Page Up, Alt+Page Down e Alt+Page Up no teclado.
largeScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;Parâmetros
- Down
-
number
- Up
-
number
- ToRight
-
number
- ToLeft
-
number
Retornos
void
Comentários
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: Excel.Interfaces.WindowLoadOptions): Excel.Window;Parâmetros
Fornece opções para quais propriedades do objeto devem ser carregadas.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): Excel.Window;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Window;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
newWindow()
Abre uma nova janela do Excel.
newWindow(): Excel.Window;Retornos
Comentários
pointsToScreenPixelsX(Points)
converte pontos horizontais em pixels da tela.
pointsToScreenPixelsX(Points: number): OfficeExtension.ClientResult<number>;Parâmetros
- Points
-
number
Retornos
OfficeExtension.ClientResult<number>
Comentários
pointsToScreenPixelsY(Points)
converte pontos verticais em pixels da tela.
pointsToScreenPixelsY(Points: number): OfficeExtension.ClientResult<number>;Parâmetros
- Points
-
number
Retornos
OfficeExtension.ClientResult<number>
Comentários
scrollIntoView(Left, Top, Width, Height, Start)
Rola a janela para exibir o 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
Retornos
void
Comentários
scrollWorkbookTabs(Sheets, Position)
Rola as guias da pasta de trabalho.
scrollWorkbookTabs(Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition): void;Parâmetros
- Sheets
-
number
- Position
- Excel.ScrollWorkbookTabPosition
Retornos
void
Comentários
scrollWorkbookTabs(Sheets, Position)
Rola as guias da pasta de trabalho.
scrollWorkbookTabs(Sheets?: number, Position?: "First" | "Last"): void;Parâmetros
- Sheets
-
number
- Position
-
"First" | "Last"
Retornos
void
Comentários
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.WindowUpdateData
Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
set(properties: Excel.Window): void;Parâmetros
- properties
- Excel.Window
Retornos
void
smallScroll(Down, Up, ToRight, ToLeft)
Rola a janela por um número de linhas ou colunas. Os downparâmetros , up, toRighte toLeft correspondem à ação de rolar com as teclas de direção no teclado.
smallScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;Parâmetros
- Down
-
number
- Up
-
number
- ToRight
-
number
- ToLeft
-
number
Retornos
void
Comentários
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.Window é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WindowData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.WindowData;