Conjuntos de requisitos da API Comum do Office
Os conjuntos de requisitos são grupos nomeados de membros da API. Os Suplementos do Office usam conjuntos de requisitos especificados no manifesto ou usam uma verificação de tempo de execução para determinar se um aplicativo do Office oferece suporte para as APIs necessárias para um suplemento. Para obter mais informações, confira Versões do Office e conjuntos de requisitos.
Dica
Procurando os conjuntos de requisitos de API específicos do aplicativo ? Confira os seguintes conjuntos de requisitos de API.
- Conjuntos de requisitos de API JavaScript para Excel (ExcelApi)
- Conjuntos de requisitos de API JavaScript para Word (WordApi)
- Conjuntos de requisitos de API JavaScript para OneNote (OneNoteApi)
- Conjuntos de requisitos da API JavaScript do PowerPoint (PowerPointApi)
- Noções básicas sobre os conjuntos de requisitos da API do Outlook (Caixa de Correio)
Conjuntos de requisitos da API Comum
As seções a seguir listam os conjuntos de requisitos de API Comum, os métodos em cada conjunto e os aplicativos cliente do Office que dão suporte a esse conjunto de requisitos. Todos esses conjuntos de requisitos da API são versão 1.1, a menos que especificado de outra forma.
Dica
Precisa de informações sobre onde os suplementos e conjuntos de requisitos têm suporte por aplicativo e versão do Office? Consulte Disponibilidade do aplicativo cliente do Office e da plataforma para suplementos do Office.
ActiveView
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - PowerPoint no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - PowerPoint na Web – PowerPoint no iPad - PowerPoint no Mac |
- Document.getActiveViewAsync |
AddInCommands
Confira Conjuntos de requisitos de comandos de suplementos.
BindingEvents
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
- Binding.addHandlerAsync - Binding.removeHandlerAsync |
CompressedFile
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2016 - Excel na Web - Excel no Mac - PowerPoint no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - PowerPoint na Web – PowerPoint no iPad - PowerPoint no Mac - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
Dá suporte à saída para o formato OOXML (Office Open XML) como uma matriz de bytes (Office.FileType.Compressed) ao usar o método Document.getFileAsync. |
CustomXmlParts
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
- CustomXmlNode.getNodesAsync - CustomXmlNode.getNodeValueAsync - CustomXmlNode.getTextAsync - CustomXmlNode.getXmlAsync - CustomXmlNode.setNodeValueAsync - CustomXmlNode.setTextAsync - CustomXmlNode.setXmlAsync – CustomXmlPart.addHandlerAsync - CustomXmlPart.deleteAsync - CustomXmlPart.getNodesAsync - CustomXmlPart.getXmlAsync - CustomXmlPart.removeHandlerAsync - CustomXmlParts.addAsync - CustomXmlParts.getByIdAsync - CustomXmlParts.getByNamespaceAsync - CustomXmlPrefixMappings.addNamespaceAsync - CustomXmlPrefixMappings.getNamespaceAsync - CustomXmlPrefixMappings.getPrefixAsync |
DialogApi
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| Confira Conjuntos de requisitos da API da Caixa de Diálogo. | - Interface do usuário.messageParent - Interface do usuário.displayDialogAsync - Interface do usuário.closeContainer -UI. Diálogo |
DialogOrigin
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| Consulte Conjuntos de requisitos de Origem do Diálogo. | Suporte entre domínios para: - Interface do usuário.messageParent -UI. Dialog.messageChild |
DocumentEvents
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac - OneNote na Web - PowerPoint no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - PowerPoint na Web – PowerPoint no iPad - PowerPoint no Mac - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
- Document.addHandlerAsync - Document.removeHandlerAsync |
Arquivo
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac - PowerPoint no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - PowerPoint na Web – PowerPoint no iPad - PowerPoint no Mac - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
- Document.getFileAsync - File.closeAsync - File.getSliceAsync |
HtmlCoercion
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - OneNote na Web - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
Dá suporte à coerção para HTML (Office.CoercionType.Html) ao ler e gravar dados usando os métodos Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync ou Binding.setDataAsync. |
IdentityAPI
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| Confira Conjuntos de requisitos da API de Identidade. | - Auth.getAccessToken |
ImageCoercion
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| Confira conjuntos de requisitos de Coerção de Imagens. | - Document.setSelectedDataAsync |
Keyboardshortcuts
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| Consulte Conjuntos de requisitos de atalhos de teclado. | - Office.actions.areShortcutsInUse - Office.actions.getShortcuts - Office.actions.replaceShortcuts |
Mailbox
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Outlook no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - novo Outlook no Windows (versão prévia) - Outlook na Web - Outlook no Android - Outlook no Mac - Outlook no iOS |
Confira Noções básicas sobre conjuntos de requisitos da API do Outlook. |
MatrixBindings
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word na web - Word no iPad - Word no Mac |
- Bindings.addFromNamedItemAsync - Bindings.addFromSelectionAsync - Bindings.getAllAsync - Bindings.getByIdAsync - Bindings.releaseByIdAsync - Binding.getDataAsync - Binding.setDataAsync |
MatrixCoercion
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
Dá suporte à coerção para a estrutura de dados “matrix” (matriz de matrizes) (Office.CoercionType.Matrix) ao ler e gravar dados usando os métodos Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync ou Binding.setDataAsync. |
OoxmlCoercion
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
Dá suporte à coerção para o formato OOXML (Open Office XML) (Office.CoercionType.Ooxml) ao ler e gravar dados usando os métodos Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync ou Binding.setDataAsync. |
OpenBrowserWindowApi
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| Consulte Abrir conjuntos de requisitos da API da Janela do Navegador. | - Office.context.ui.openBrowserWindow |
PartialTableBindings
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| Nenhuma. |
PdfFile
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no Mac - PowerPoint no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - PowerPoint na Web – PowerPoint no iPad - PowerPoint no Mac - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
Dá suporte à saída para o formato PDF (Office.FileType.Pdf) ao usar o método Document.getFileAsync. |
RibbonApi
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| Consulte Conjuntos de requisitos da API da Faixa de Opções. | - Office.ribbon.requestUpdate |
Seleção
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac - PowerPoint no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - PowerPoint na Web – PowerPoint no iPad - PowerPoint no Mac - Projeto no Windows -- Office 2013 perpétuo licenciado por volume - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
- Document.getSelectedDataAsync - Document.setSelectedDataAsync |
Configurações
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac - OneNote na Web - PowerPoint no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - PowerPoint na Web – PowerPoint no iPad - PowerPoint no Mac - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
- Configurações.get - Configurações.remover - Settings.saveAsync - Settings.set |
SharedRuntime
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| Consulte Conjuntos de requisitos de runtime compartilhados. | - Office.addin.getStartupBehavior - Office.addin.hide - Office.addin.onVisibilityModeChanged - Office.addin.setStartupBehavior - Office.addin.showAsTaskpane - Office.BeforeDocumentCloseNotification.disable - Office.BeforeDocumentCloseNotification.enable - Office.BeforeDocumentCloseNotification.onCloseActionCancelled |
TableBindings
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
- Bindings.addFromNamedItemAsync - Bindings.addFromSelectionAsync - Bindings.getAllAsync - Bindings.getByIdAsync - Bindings.releaseByIdAsync - Binding.addColumnsAsync - Binding.addRowsAsync - Binding.deleteAllDataValuesAsync - Binding.getDataAsync - Binding.setDataAsync |
TableCoercion
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
Dá suporte à coerção para a estrutura de dados “table” (Office.CoercionType.Table) ao ler e gravar dados usando os métodos Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync ou Binding.setDataAsync. |
TextBindings
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
- Bindings.addFromNamedItemAsync - Bindings.addFromSelectionAsync - Bindings.getAllAsync - Bindings.getByIdAsync - Bindings.releaseByIdAsync - Binding.getDataAsync - Binding.setDataAsync |
TextCoercion
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - OneNote na Web - PowerPoint no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - PowerPoint na Web – PowerPoint no iPad - PowerPoint no Mac - Projeto no Windows -- Office 2013 perpétuo licenciado por volume - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
Dá suporte à coerção para o formato de texto (Office.CoercionType.Text) ao ler e gravar dados usando os métodos Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync ou Binding.setDataAsync. |
TextFile
| Suporte mínimo de aplicativo do Office | Métodos no conjunto |
|---|---|
| - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word no Mac - Word na web - Word no iPad |
Dá suporte à saída para o formato de texto (Office.FileType.Text) ao usar o método Document.getFileAsync. |
Métodos que não fazem parte de um conjunto de requisitos
Os métodos a seguir na API JavaScript do Office não fazem parte de um conjunto de requisitos. Se o suplemento exigir qualquer um desses métodos, use os <elementos Métodos> e <Métodos> no manifesto do suplemento para declarar que eles são necessários ou executar o runtime marcar usando uma instruçãoif. Para obter mais informações, consulte Especificar aplicativos do Office e requisitos de API.
| Nome do método | Suporte mínimo de aplicativo do Office |
|---|---|
| Bindings.addFromPromptAsync | - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac |
| Document.getFilePropertiesAsync | - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac - PowerPoint no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - PowerPoint na Web – PowerPoint no iPad - PowerPoint no Mac - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word na web - Word no iPad - Word no Mac |
| Document.getProjectFieldAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getResourceFieldAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getSelectedResourceAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getSelectedTaskAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getSelectedViewAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getTaskAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.getTaskFieldAsync | - Project Standard 2013 - Project Professional 2013 |
| Document.goToByIdAsync | - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac - PowerPoint no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - PowerPoint na Web – PowerPoint no iPad - PowerPoint no Mac - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word na web - Word no iPad - Word no Mac |
| Settings.addHandlerAsync | - Excel na Web |
| Settings.refreshAsync | - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - PowerPoint no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - PowerPoint na Web - Word no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Word na web |
| Settings.removeHandlerAsync | - Excel na Web |
| TableBinding.clearFormatsAsync | - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac |
| TableBinding.setFormatsAsync | - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac |
| TableBinding.setTableOptionsAsync | - Excel no Windows -- Assinatura do Microsoft 365 -- perpétuo Office 2013 - Excel na Web - Excel no iPad - Excel no Mac |
Confira também
Colaborar conosco no GitHub
A fonte deste conteúdo pode ser encontrada no GitHub, onde você também pode criar e revisar problemas e solicitações de pull. Para obter mais informações, confira o nosso guia para colaboradores.
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de