Conjunto de requisitos apenas online da API javaScript do Excel
O ExcelApiOnline conjunto de requisitos é um conjunto de requisitos especial que inclui funcionalidades que só estão disponíveis para Excel na Web. As APIs neste conjunto de requisitos são consideradas APIs de produção (não sujeitas a alterações comportamentais ou estruturais não documentadas) para a aplicação Excel na Web.
ExcelApiOnline As APIs são consideradas APIs de "pré-visualização" para outras plataformas (Windows, Mac, iOS) e podem não ser suportadas por nenhuma dessas plataformas.
Quando as APIs no ExcelApiOnline 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 serão removidas do ExcelApiOnline. Pense nisto como um processo de promoção semelhante a uma API que passa da pré-visualização para a versão.
Importante
ExcelApiOnline é um superconjunto do mais recente conjunto de requisitos numerados.
Importante
ExcelApiOnline 1.1 é a única versão das APIs apenas online. Isto acontece porque Excel na Web terá sempre uma única versão disponível para os utilizadores que é a versão mais recente.
A tabela seguinte fornece um resumo conciso das APIs, enquanto a tabela da lista de API subsequente apresenta uma lista detalhada das APIs atuais ExcelApiOnline .
| Área de recurso | Descrição | Objetos relevantes |
|---|---|---|
| Livros ligados | Gerir ligações entre livros, incluindo suporte para atualização e interrupção de ligações de livros. | LinkedWorkbook, LinkedWorkbookCollection |
| Vistas de folha com nome | Fornece controlo programático das vistas de folha de cálculo por utilizador. | NamedSheetView, NamedSheetViewCollection |
| Eventos de movimentação da folha de cálculo | Detetar quando as folhas de cálculo são movidas dentro de uma coleção, a posição da folha de cálculo e a origem da alteração. | WorksheetCollection, WorksheetMovedEventArgs |
| Proteção da folha de cálculo | Impedir que utilizadores não autorizados façam alterações a intervalos especificados numa folha de cálculo. | WorksheetProtection, AllowEditRange, AllowEditRangeCollection, AllowEditRangeOptions |
Utilização recomendada
Uma ExcelApiOnline vez que as APIs só são suportadas por Excel na Web, o suplemento deve marcar se o conjunto de requisitos for suportado antes de chamar estas APIs. Isto evita chamar uma API apenas online numa plataforma diferente.
if (Office.context.requirements.isSetSupported("ExcelApiOnline", "1.1")) {
// Any API exclusive to the ExcelApiOnline 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 ExcelApiOnline 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 ExcelApiOnline conjunto de requisitos. Para obter uma lista completa de todas as APIs JavaScript do Excel (incluindo ExcelApiOnline APIs e APIs lançadas anteriormente), veja todas as APIs JavaScript do Excel.
| Classe | Campos | Descrição |
|---|---|---|
| AllowEditRange | address | Especifica o intervalo associado ao objeto. |
| delete() | Elimina o objeto de AllowEditRangeCollection. |
|
| isPasswordProtected | Especifica se o objeto está protegido por palavra-passe. | |
| pauseProtection(palavra-passe?: cadeia) | Coloca em pausa a proteção da folha de cálculo para o objeto do utilizador na sessão atual. | |
| setPassword(palavra-passe?: cadeia) | Altera a palavra-passe associada ao objeto. | |
| title | Especifica o título do objeto. | |
| AllowEditRangeCollection | add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions) | Adiciona um AllowEditRange objeto à folha de cálculo. |
| getCount() | Devolve o número de AllowEditRange objetos na coleção. |
|
| getItem(key: string) | Obtém o AllowEditRange objeto pelo respetivo título. |
|
| getItemAt(index: number) | Devolve um AllowEditRange objeto pelo respetivo índice na coleção. |
|
| getItemOrNullObject(key: string) | Obtém o AllowEditRange objeto pelo respetivo título. |
|
| items | Obtém os itens filhos carregados nesta coleção. | |
| pauseProtection(palavra-passe: cadeia) | Coloca em pausa a proteção da folha de cálculo para todos os AllowEditRange objetos encontrados nesta folha de cálculo que tenham a palavra-passe especificada para o utilizador na sessão atual. |
|
| AllowEditRangeOptions | senha | A palavra-passe associada ao AllowEditRange. |
| LinkedWorkbook | breakLinks() | Faz um pedido para interromper as ligações que apontam para o livro ligado. |
| id | O URL original que aponta para o livro ligado. | |
| refresh() | Faz um pedido para atualizar os dados obtidos a partir do livro ligado. | |
| LinkedWorkbookCollection | breakAllLinks() | Quebra todas as ligações para os livros ligados. |
| getItem(key: string) | Obtém informações sobre um livro ligado através do respetivo URL. | |
| getItemOrNullObject(key: string) | Obtém informações sobre um livro ligado através do respetivo URL. | |
| items | Obtém os itens filhos carregados nesta coleção. | |
| refreshAll() | Faz um pedido para atualizar todas as ligações do livro. | |
| workbookLinksRefreshMode | Representa o modo de atualização das ligações do livro. | |
| NamedSheetView | activate() | Ativa esta vista de folha. |
| delete() | Remove a vista de folha da folha de cálculo. | |
| duplicado(nome?: cadeia) | Cria uma cópia desta vista de folha. | |
| name | Obtém ou define o nome da vista de folha. | |
| NamedSheetViewCollection | add(name: string) | Cria uma nova vista de folha com o nome especificado. |
| enterTemporary() | Cria e ativa uma nova vista de folha temporária. | |
| exit() | Sai da vista de folha atualmente ativa. | |
| getActive() | Obtém a vista de folha de cálculo atualmente ativa. | |
| getCount() | Obtém o número de vistas de folha nesta folha de cálculo. | |
| getItem(key: string) | Obtém uma vista de folha com o respetivo nome. | |
| getItemAt(index: number) | Obtém uma vista de folha pelo respetivo índice na coleção. | |
| items | Obtém os itens filhos carregados nesta coleção. | |
| TableRowCollection | deleteRows(linhas: número[] | TableRow[]) | Eliminar várias linhas de uma tabela. |
| deleteRowsAt(índice: número, contagem?: número) | Elimine um número especificado de linhas de uma tabela, começando num determinado índice. | |
| Pasta de trabalho | linkedWorkbooks | Devolve uma coleção de livros ligados. |
| Planilha | namedSheetViews | Devolve uma coleção de vistas de folha que estão presentes na folha de cálculo. |
| WorksheetProtection | allowEditRanges | Especifica o AllowEditRangeCollection objeto encontrado nesta folha de cálculo. |
| canPauseProtection | Especifica se a proteção pode ser colocada em pausa para esta folha de cálculo. | |
| checkPassword(palavra-passe?: cadeia) | Especifica se a palavra-passe pode ser utilizada para desbloquear a proteção da folha de cálculo. | |
| isPasswordProtected | Especifica se a folha está protegida por palavra-passe. | |
| isPaused | Especifica se a proteção da folha de cálculo está em pausa. | |
| pauseProtection(palavra-passe?: cadeia) | Coloca em pausa a proteção da folha de cálculo para o objeto de folha de cálculo especificado para o utilizador na sessão atual. | |
| resumeProtection() | Retoma a proteção da folha de cálculo para o objeto de folha de cálculo especificado para o utilizador numa determinada sessão. | |
| savedOptions | Especifica as opções de proteção guardadas na folha de cálculo. | |
| setPassword(palavra-passe?: cadeia) | Altera a palavra-passe associada ao WorksheetProtection objeto. |
|
| updateOptions(opções: Excel.WorksheetProtectionOptions) | Altere as opções de proteção da folha de cálculo associadas ao WorksheetProtection objeto. |
|
| WorksheetProtectionChangedEventArgs | allowEditRangesChanged | Especifica se algum dos AllowEditRange objetos foi alterado. |
| protectionOptionsChanged | Especifica se o WorksheetProtectionOptions foi alterado. |
|
| sheetPasswordChanged | Especifica se a palavra-passe da folha de cálculo foi alterada. |