Conjunto de requisitos somente online da API JavaScript do Excel

  • Artigo

O ExcelApiOnline conjunto de requisitos é um conjunto de requisitos especial que inclui recursos disponíveis apenas para Excel na Web. As APIs nesse conjunto de requisitos são consideradas APIs de produção (não sujeitas a alterações comportamentais ou estruturais não documentadas) para o aplicativo Excel na Web. ExcelApiOnline As APIs são consideradas APIs de "visualização" para outras plataformas (Windows, Mac, iOS) e podem não ter suporte em nenhuma dessas plataformas.

Quando as APIs no ExcelApiOnline conjunto de requisitos tiverem suporte em todas as plataformas, elas serão adicionadas ao próximo conjunto de requisitos lançado (ExcelApi 1.[NEXT]). Depois que esse novo requisito for público, essas APIs serão removidas de ExcelApiOnline. Pense nisso como um processo de promoção semelhante a uma API que passa da versão prévia para a versão.

Importante

ExcelApiOnline é um superconjunto do conjunto de requisitos numerado mais recente.

Importante

ExcelApiOnline 1.1 é a única versão das APIs somente online. Isso ocorre porque Excel na Web sempre terá uma única versão disponível para usuários que é a versão mais recente.

A tabela a seguir fornece um resumo conciso das APIs, enquanto a tabela de lista de API subsequente fornece uma lista detalhada das APIs atuais ExcelApiOnline .

Área de recurso Descrição Objetos relevantes
Pastas de trabalho vinculadas Gerenciar links entre pastas de trabalho, incluindo suporte para atualizar e quebrar links de pasta de trabalho. LinkedWorkbook, LinkedWorkbookCollection
Exibições de planilha nomeadas Fornece controle programático de exibições de planilha por usuário. NamedSheetView, NamedSheetViewCollection
Eventos de movimentação de planilha Detecte quando as planilhas são movidas dentro de uma coleção, a posição da planilha e a origem da alteração. WorksheetCollection, WorksheetMovedEventArgs
Proteção de planilha Impedir que usuários não autorizados façam alterações em intervalos especificados em uma planilha. WorksheetProtection, AllowEditRange, AllowEditRangeCollection, AllowEditRangeOptions

Como ExcelApiOnline as APIs só têm suporte por Excel na Web, seu suplemento deve marcar se o conjunto de requisitos tiver suporte antes de chamar essas APIs. Isso evita chamar uma API somente online em uma plataforma diferente.

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

Depois que a API estiver em um conjunto de requisitos entre plataformas, você deverá remover ou editar o isSetSupported marcar. Isso habilitará o recurso do suplemento em outras plataformas. Certifique-se de testar o recurso nessas plataformas ao fazer essa alteração.

Importante

Seu manifesto não pode especificar ExcelApiOnline 1.1 como um requisito de ativação. Não é um valor válido a ser usado no elemento Set.

Lista de API

A tabela a seguir 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), consulte todas as APIs JavaScript do Excel.

Classe Campos Descrição
AllowEditRange address Especifica o intervalo associado ao objeto.
delete() Exclui o objeto do AllowEditRangeCollection.
isPasswordProtected Especifica se o objeto está protegido por senha.
pauseProtection(password?: string) Pausa a proteção de planilha para o objeto para o usuário na sessão atual.
setPassword(password?: string) Altera a senha associada ao objeto.
title Especifica o título do objeto.
AllowEditRangeCollection add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions) Adiciona um AllowEditRange objeto à planilha.
getCount() Retorna o número de AllowEditRange objetos na coleção.
getItem(key: string) Obtém o AllowEditRange objeto pelo título.
getItemAt(index: number) Retorna um AllowEditRange objeto por seu índice na coleção.
getItemOrNullObject(key: string) Obtém o AllowEditRange objeto pelo título.
items Obtém os itens filhos carregados nesta coleção.
pauseProtection(senha: cadeia de caracteres) Pausa a proteção de planilha para todos os AllowEditRange objetos encontrados nesta planilha que têm a senha fornecida para o usuário na sessão atual.
AllowEditRangeOptions senha A senha associada ao AllowEditRange.
LinkedWorkbook breakLinks() Faz uma solicitação para quebrar os links que apontam para a pasta de trabalho vinculada.
id A URL original apontando para a pasta de trabalho vinculada.
refresh() Faz uma solicitação para atualizar os dados recuperados da pasta de trabalho vinculada.
LinkedWorkbookCollection breakAllLinks() Quebra todos os links para as pastas de trabalho vinculadas.
getItem(key: string) Obtém informações sobre uma pasta de trabalho vinculada por sua URL.
getItemOrNullObject(key: string) Obtém informações sobre uma pasta de trabalho vinculada por sua URL.
items Obtém os itens filhos carregados nesta coleção.
refreshAll() Faz uma solicitação para atualizar todos os links da pasta de trabalho.
workbookLinksRefreshMode Representa o modo de atualização dos links da pasta de trabalho.
NamedSheetView activate() Ativa essa exibição de planilha.
delete() Remove a exibição da planilha da planilha.
duplicate(name?: string) Cria uma cópia desse modo de exibição de planilha.
name Obtém ou define o nome da exibição da planilha.
NamedSheetViewCollection add(name: string) Cria uma nova exibição de planilha com o nome fornecido.
enterTemporary() Cria e ativa uma nova exibição de planilha temporária.
exit() Sai do modo de exibição da planilha ativa no momento.
getActive() Obtém a exibição da planilha ativa atualmente.
getCount() Obtém o número de exibições de planilha nesta planilha.
getItem(key: string) Obtém uma exibição de planilha usando seu nome.
getItemAt(index: number) Obtém uma exibição de planilha por seu índice na coleção.
items Obtém os itens filhos carregados nesta coleção.
TableRowCollection deleteRows(linhas: number[] | TableRow[]) Exclua várias linhas de uma tabela.
deleteRowsAt(index: number, count?: number) Exclua um número especificado de linhas de uma tabela, começando em um determinado índice.
Pasta de trabalho linkedWorkbooks Retorna uma coleção de pastas de trabalho vinculadas.
Planilha namedSheetViews Retorna uma coleção de exibições de planilha que estão presentes na planilha.
WorksheetProtection allowEditRanges Especifica o AllowEditRangeCollection objeto encontrado nesta planilha.
canPauseProtection Especifica se a proteção pode ser pausada para essa planilha.
checkPassword(password?: string) Especifica se a senha pode ser usada para desbloquear a proteção de planilha.
isPasswordProtected Especifica se a planilha é protegida por senha.
Ispaused Especifica se a proteção de planilha está pausada.
pauseProtection(password?: string) Pausa a proteção de planilha para o objeto de planilha fornecido para o usuário na sessão atual.
resumeProtection() Retoma a proteção de planilha para o objeto de planilha fornecido para o usuário em uma determinada sessão.
savedOptions Especifica as opções de proteção salvas na planilha.
setPassword(password?: string) Altera a senha associada ao WorksheetProtection objeto.
updateOptions(opções: Excel.WorksheetProtectionOptions) Altere as opções de proteção de planilha 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 senha da planilha foi alterada.

Confira também