Excel.Window class
Representa uma janela no livro.
- Extends
Comentários
Propriedades
| active |
Especifica a célula ativa na janela. |
| active |
Especifica o painel ativo na janela. |
| active |
Especifica a folha ativa na janela. |
| auto |
Especifica se o agrupamento de datas do Filtro Automático está ativado na janela. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| enable |
Especifica se o redimensionamento está ativado para a janela. |
| freeze |
Especifica se os painéis estão bloqueados 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, desde a margem esquerda do ecrã do computador até à margem 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 deslocamento da janela. |
| scroll |
Especifica a linha de deslocamento da janela. |
| show |
Especifica se as fórmulas são apresentadas na janela. |
| show |
Especifica se as linhas de grelha são apresentadas na janela. |
| show |
Especifica se os cabeçalhos são apresentados na janela. |
| show |
Especifica se a barra de deslocamento horizontal é apresentada na janela. |
| show |
Especifica se o destaque é apresentado na janela. |
| show |
Obtém o valor de esquema da direita para a esquerda da janela. Verdadeiro significa que a janela está a utilizar o esquema da direita para a esquerda, falso significa que a janela está a utilizar o esquema da esquerda para a direita. |
| show |
Especifica se a régua é apresentada na janela. |
| show |
Especifica se a barra de deslocamento vertical é apresentada na janela. |
| show |
Especifica se o espaço em branco é apresentado na janela. |
| show |
Especifica se os separadores do livro são apresentados na janela. |
| show |
Especifica se os zeros são apresentados 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 dividida da janela. |
| split |
Especifica a divisão vertical da janela. |
| tab |
Especifica a proporção de tabulação da janela. |
| top | Especifica a distância, em pontos, desde a margem superior da janela até à margem superior da área utilizável (abaixo dos menus, todas as barras de ferramentas ancoradas 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 a vista da janela. |
| visible |
Obtém o intervalo visível da janela. |
| width | Especifica a largura de apresentaçã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 apresentação da janela. Pode ser definido como uma percentagem entre 10 e 400. |
Métodos
| activate() | Ativa a janela. |
| activate |
Ativa a janela seguinte. |
| activate |
Ativa a janela anterior. |
| close() | Fecha a janela. |
| large |
Desloca a janela por múltiplas 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 píxeis de ecrã. |
| points |
Converte pontos verticais em píxeis de ecrã. |
| scroll |
Desloca a janela para ver o intervalo especificado. |
| scroll |
Desloca os separadores do livro. |
| scroll |
Desloca os separadores do livro. |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| small |
Desloca 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 folha ativa na janela.
readonly activeWorksheet: Excel.Worksheet;
Valor da propriedade
Comentários
autoFilterDateGroupingEnabled
Especifica se o agrupamento de datas do Filtro Automático está ativado na janela.
autoFilterDateGroupingEnabled: boolean;
Valor da propriedade
boolean
Comentários
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
context: RequestContext;
Valor da propriedade
enableResize
Especifica se o redimensionamento está ativado para a janela.
readonly enableResize: boolean;
Valor da propriedade
boolean
Comentários
freezePanes
Especifica se os painéis estão bloqueados 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, desde a margem esquerda do ecrã do computador até à margem 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
[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]
scrollColumn
Especifica a coluna de deslocamento da janela.
scrollColumn: number;
Valor da propriedade
number
Comentários
scrollRow
Especifica a linha de deslocamento da janela.
scrollRow: number;
Valor da propriedade
number
Comentários
showFormulas
Especifica se as fórmulas são apresentadas na janela.
showFormulas: boolean;
Valor da propriedade
boolean
Comentários
showGridlines
Especifica se as linhas de grelha são apresentadas na janela.
showGridlines: boolean;
Valor da propriedade
boolean
Comentários
showHeadings
Especifica se os cabeçalhos são apresentados na janela.
showHeadings: boolean;
Valor da propriedade
boolean
Comentários
showHorizontalScrollBar
Especifica se a barra de deslocamento horizontal é apresentada na janela.
showHorizontalScrollBar: boolean;
Valor da propriedade
boolean
Comentários
showOutline
Especifica se o destaque é apresentado na janela.
showOutline: boolean;
Valor da propriedade
boolean
Comentários
showRightToLeft
Obtém o valor de esquema da direita para a esquerda da janela. Verdadeiro significa que a janela está a utilizar o esquema da direita para a esquerda, falso significa que a janela está a utilizar o esquema da esquerda para a direita.
readonly showRightToLeft: boolean;
Valor da propriedade
boolean
Comentários
showRuler
Especifica se a régua é apresentada na janela.
showRuler: boolean;
Valor da propriedade
boolean
Comentários
showVerticalScrollBar
Especifica se a barra de deslocamento vertical é apresentada na janela.
showVerticalScrollBar: boolean;
Valor da propriedade
boolean
Comentários
showWhitespace
Especifica se o espaço em branco é apresentado na janela.
showWhitespace: boolean;
Valor da propriedade
boolean
Comentários
showWorkbookTabs
Especifica se os separadores do livro são apresentados na janela.
showWorkbookTabs: boolean;
Valor da propriedade
boolean
Comentários
showZeros
Especifica se os zeros são apresentados 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 dividida 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 tabulação da janela.
tabRatio: number;
Valor da propriedade
number
Comentários
top
Especifica a distância, em pontos, desde a margem superior da janela até à margem superior da área utilizável (abaixo dos menus, todas as barras de ferramentas ancoradas 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 a vista 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 apresentaçã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 apresentação da janela. Pode ser definido como uma percentagem entre 10 e 400.
zoom: number;
Valor da propriedade
number
Comentários
Detalhes do método
activate()
Ativa a janela.
activate(): void;
Retornos
void
Comentários
activateNext()
Ativa a janela seguinte.
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)
Desloca a janela por múltiplas páginas. Os downparâmetros , up, toRighte toLeft correspondem à ação de deslocar 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 as propriedades do objeto a carregar.
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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
newWindow()
Abre uma nova janela do Excel.
newWindow(): Excel.Window;
Retornos
Comentários
pointsToScreenPixelsX(Points)
Converte pontos horizontais em píxeis de ecrã.
pointsToScreenPixelsX(Points: number): OfficeExtension.ClientResult<number>;
Parâmetros
- Points
-
number
Retornos
OfficeExtension.ClientResult<number>
Comentários
pointsToScreenPixelsY(Points)
Converte pontos verticais em píxeis de ecrã.
pointsToScreenPixelsY(Points: number): OfficeExtension.ClientResult<number>;
Parâmetros
- Points
-
number
Retornos
OfficeExtension.ClientResult<number>
Comentários
scrollIntoView(Left, Top, Width, Height, Start)
Desloca a janela para ver 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)
Desloca os separadores do livro.
scrollWorkbookTabs(Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition): void;
Parâmetros
- Sheets
-
number
- Position
- Excel.ScrollWorkbookTabPosition
Retornos
void
Comentários
scrollWorkbookTabs(Sheets, Position)
Desloca os separadores do livro.
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. Pode transmitir um objeto simples com as propriedades adequadas 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 que são estruturadas isomorfoticamente 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 quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Excel.Window): void;
Parâmetros
- properties
- Excel.Window
Retornos
void
smallScroll(Down, Up, ToRight, ToLeft)
Desloca a janela por um número de linhas ou colunas. Os downparâmetros , up, toRighte toLeft correspondem à ação de deslocamento com teclas de seta 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.Window é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.WindowData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.WindowData;