Compartilhar via


Excel JavaScript API desktop-only requirement set 1.1

O ExcelApiDesktop conjunto de requisitos é um conjunto de requisitos especial que inclui funcionalidades que só estão disponíveis no Excel para Windows e Excel para Mac. As APIs neste conjunto de requisitos são consideradas APIs de produção para a aplicação Excel no Windows e Mac. Seguem as políticas de suporte para programadores do Microsoft 365. ExcelApiDesktop As APIs são consideradas APIs de "pré-visualização" para outras plataformas (como a Web e o iPad) e podem não ser suportadas por nenhuma dessas plataformas.

Quando as APIs no ExcelApiDesktop conjunto de requisitos são suportadas em todas as plataformas, serão adicionadas ao próximo conjunto de requisitos de lançamento (ExcelApi 1.[NEXT]). Assim que o novo conjunto de requisitos for público, essas APIs também continuarão a ser etiquetadas neste ExcelApiDesktop conjunto de requisitos. Para saber mais sobre os requisitos específicos da plataforma em geral, veja Compreender os conjuntos de requisitos específicos da plataforma.

Importante

ExcelApiDesktop 1.1 é um conjunto de requisitos apenas para ambiente de trabalho. É um superconjunto do ExcelApi 1.20.

Uma vez que as ExcelApiDesktop 1.1 APIs só são suportadas pelo Excel no Windows e Mac, o seu suplemento deve marcar se o conjunto de requisitos for suportado antes de chamar estas APIs. Isto evita qualquer tentativa de utilização de APIs apenas de ambiente de trabalho numa plataforma não suportada.

if (Office.context.requirements.isSetSupported("ExcelApiDesktop", "1.1")) {
   // Any API exclusive to this ExcelApiDesktop requirement set.
}

Assim que a API estiver num conjunto de requisitos para várias plataformas, deve remover ou editar o isSetSupported marcar. Isto irá ativar a funcionalidade do seu suplemento noutras plataformas. Certifique-se de que testa a funcionalidade nessas plataformas ao efetuar esta alteração.

Importante

O manifesto não pode especificar ExcelApiDesktop 1.1 como um requisito de ativação. Não é um valor válido a utilizar no elemento Set.

Lista de API

A tabela seguinte lista as APIs javaScript do Excel atualmente incluídas no ExcelApiDesktop 1.1 conjunto de requisitos. Para obter uma lista completa de todas as APIs JavaScript do Excel (incluindo ExcelApiDesktop 1.1 APIs e APIs lançadas anteriormente), veja todas as APIs JavaScript do Excel.

Classe Campos Descrição
Aplicativo activeWindow Devolve um window objeto que representa a janela ativa (a janela na parte superior).
checkSpelling(word: cadeia, opções?: Excel.CheckSpellingOptions) Verifica a ortografia de uma única palavra.
enterEditingMode() Entra no modo de edição do intervalo selecionado na folha de cálculo ativa.
union(firstRange: Intervalo | RangeAreas, secondRange: Intervalo | RangeAreas, ... additionalRanges: (Intervalo | IntervaloS)[]) Devolve um RangeAreas objeto que representa a união de dois ou mais Range objetos.RangeAreas
windows Devolve todas as janelas abertas do Excel.
CheckSpellingOptions customDictionary Opcional.
ignoreUppercase Opcional.
HeaderFooter centerFooterPicture Obtém um HeaderFooterPicture objeto que representa a imagem da secção central do rodapé.
centerHeaderPicture Obtém um HeaderFooterPicture objeto que representa a imagem da secção central do cabeçalho.
leftFooterPicture Obtém um HeaderFooterPicture objeto que representa a imagem da secção esquerda do rodapé.
leftHeaderPicture Obtém um HeaderFooterPicture objeto que representa a imagem da secção esquerda do cabeçalho.
rightFooterPicture Obtém um HeaderFooterPicture objeto que representa a imagem da secção correta do rodapé.
rightHeaderPicture Obtém um HeaderFooterPicture objeto que representa a imagem da secção correta do cabeçalho.
HeaderFooterPicture luminosidade Especifica a luminosidade da imagem.
colorType Especifica o tipo de transformação de cor da imagem.
contraste Especifica o contraste da imagem.
cropBottom Especifica o número de pontos que são recortados na parte inferior da imagem.
cropLeft Especifica o número de pontos que são recortados do lado esquerdo da imagem.
cropRight Especifica o número de pontos que são recortados no lado direito da imagem.
cropTop Especifica o número de pontos que são recortados na parte superior da imagem.
nome do ficheiro Especifica o URL (na intranet ou na Web) ou o caminho (local ou rede) para a localização onde o objeto de origem é guardado.
height Especifica a altura da imagem em pontos.
lockAspectRatio Especifica um valor que indica se a imagem mantém as proporções originais quando redimensionada.
width Especifica a largura da imagem em pontos.
Imagem luminosidade Especifica a luminosidade da imagem.
colorType Especifica o tipo de transformação de cor aplicado à imagem.
contraste Especifica o contraste da imagem.
cropBottom Especifica o número de pontos que são recortados na parte inferior da imagem.
cropLeft Especifica o número de pontos que são recortados do lado esquerdo da imagem.
cropRight Especifica o número de pontos que são recortados do lado direito da imagem.
cropTop Especifica o número de pontos que são recortados na parte superior da imagem.
incrementBrightness(incremento: número) Incrementa a luminosidade da imagem por uma quantidade especificada.
incrementContrast(incremento: número) Incrementa o contraste da imagem por uma quantidade especificada.
PageLayout alignMarginsHeaderFooter Especifica se o Excel alinha o cabeçalho e o rodapé com as margens definidas nas opções de configuração da página.
printQuality Especifica uma matriz de dois elementos que contém valores de qualidade de impressão horizontal e vertical.
Painel índice Devolve o índice do painel.
PaneCollection getCount() Devolve o número de painéis na coleção.
getItemAt(index: number) Obtém o painel na coleção por índice.
items Obtém os itens filhos carregados nesta coleção.
Range checkSpelling(options?: Excel.CheckSpellingOptions) Verifica a ortografia das palavras neste intervalo.
formulaArray Especifica a fórmula de matriz de um intervalo.
showDependents(remove?: booleano) Desenha setas rastreadoras para os dependentes diretos do intervalo.
showPrecedents(remove?: booleano) Desenha setas rastreadoras para os precedentes diretos do intervalo.
Janela activate() Ativa a janela.
activateNext() Ativa a janela seguinte.
activatePrevious() Ativa a janela anterior.
activeCell Obtém a célula ativa na janela.
activePane Obtém o painel ativo na janela.
activeWorksheet Obtém a folha de cálculo ativa na janela.
autoFilterDateGroupingEnabled Especifica se o agrupamento de datas do Filtro Automático está ativado na janela.
fechar() Fecha a janela.
enableResize Especifica se o redimensionamento está ativado para a janela.
fixar Painéis Especifica se os painéis estão bloqueados na janela.
height Especifica a altura da janela.
índice Obtém o índice da janela.
isVisible Especifica se a janela está visível.
largeScroll(Down: number, Up: number, ToRight: number, ToLeft: number) Desloca a janela por múltiplas páginas.
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.
newWindow() Abre uma nova janela do Excel.
painéis Obtém uma coleção de painéis associados à janela.
pointsToScreenPixelsX(Points: number) Converte pontos horizontais em píxeis de ecrã.
pointsToScreenPixelsY(Pontos: número) Converte pontos verticais em píxeis de ecrã.
scrollColumn Especifica a coluna de deslocamento da janela.
scrollIntoView(Left: number, Top: number, Width: number, Height: number, Start?: boolean) Desloca a janela para ver o intervalo especificado.
scrollRow Especifica a linha de deslocamento da janela.
scrollWorkbookTabs(Folhas?: número, Posição?: Excel.ScrollWorkbookTabPosition) Desloca os separadores do livro.
showFormulas Especifica se as fórmulas são apresentadas na janela.
showGridlines Especifica se as linhas de grelha são apresentadas na janela.
showHeadings Especifica se os cabeçalhos são apresentados na janela.
showHorizontalScrollBar Especifica se a barra de deslocamento horizontal é apresentada na janela.
showOutline Especifica se o destaque é apresentado na janela.
showRightToLeft Obtém o valor de esquema da direita para a esquerda da janela.
showRuler Especifica se a régua é apresentada na janela.
showVerticalScrollBar Especifica se a barra de deslocamento vertical é apresentada na janela.
showWhitespace Especifica se o espaço em branco é apresentado na janela.
showWorkbookTabs Especifica se os separadores do livro são apresentados na janela.
showZeros Especifica se os zeros são apresentados na janela.
smallScroll(Down: number, Up: number, ToRight: number, ToLeft: number) Desloca a janela por um número de linhas ou colunas.
dividir Especifica o estado de divisão da janela.
splitColumn Especifica a coluna dividida da janela.
splitHorizontal Especifica a divisão horizontal da janela.
splitRow Especifica a linha dividida da janela.
splitVertical Especifica a divisão vertical da janela.
tabRatio 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.
usableHeight Obtém a altura utilizável da janela.
usableWidth Obtém a largura utilizável da janela.
view Especifica a vista da janela.
visibleRange Obtém o intervalo visível da janela.
width Especifica a largura de apresentação da janela.
windowNumber Obtém o número da janela.
windowState Especifica o estado da janela.
zoom Especifica um valor inteiro que representa o tamanho de apresentação da janela.
WindowCollection breakSideBySide() Quebra a vista lado a lado das janelas.
compareCurrentSideBySideWith(windowName: string) Compara a janela atual lado a lado com a janela especificada.
getCount() Obtém o número de janelas na coleção.
getItemAt(index: number) Obtém a Janela na coleção por índice.
items Obtém os itens filhos carregados nesta coleção.
resetPositionsSideBySide() Repõe as posições das janelas na vista lado a lado.
Pasta de trabalho focus() Define o foco no livro.
Planilha checkSpelling(options?: Excel.CheckSpellingOptions) Verifica a ortografia das palavras nesta folha de cálculo.
clearArrows() Limpa as setas de rastreamento da planilha.
evaluate(name: string) Devolve o resultado da avaliação de uma cadeia de fórmulas.

Confira também