Conjuntos de requisitos de la API común de Office
Los conjuntos de requisitos son grupos de miembros de la API con nombre. Los complementos de Office usan los conjuntos de requisitos especificados en el manifiesto o usan una comprobación en tiempo de ejecución para determinar si una aplicación de Office admite las API necesarias para el complemento. Para obtener más información, vea Versiones y conjuntos de requisitos de Office.
Sugerencia
¿Busca los conjuntos de requisitos de API específicos de la aplicación ? Consulte los siguientes conjuntos de requisitos de API.
- Conjuntos de requisitos de la API de JavaScript de Excel (ExcelApi)
- Conjuntos de requisitos de la API de JavaScript de Word (WordApi)
- Conjuntos de requisitos de la API de JavaScript de OneNote (OneNoteApi)
- Conjuntos de requisitos de la API de JavaScript de PowerPoint (PowerPointApi)
- Entender los conjuntos de requisitos de la API de Outlook (Mailbox)
Conjuntos de requisitos de las API comunes
En las secciones siguientes se enumeran los conjuntos de requisitos de Common API, los métodos de cada conjunto y las aplicaciones cliente de Office que admiten ese conjunto de requisitos. Todos estos conjuntos de requisitos de la API son de la versión 1.1, a menos que se indique lo contrario.
Sugerencia
¿Necesita información sobre dónde admiten la aplicación y la versión de Office los complementos y los conjuntos de requisitos? Consulte Disponibilidad de la plataforma y la aplicación cliente de Office para complementos de Office.
ActiveView
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - PowerPoint en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - PowerPoint en la Web - PowerPoint en iPad - PowerPoint en Mac |
- Document.getActiveViewAsync |
AddInCommands
Vea Conjuntos de requisitos de comandos de complementos.
BindingEvents
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
- Binding.addHandlerAsync - Binding.removeHandlerAsync |
CompressedFile
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2016 - Excel en la Web - Excel en Mac - PowerPoint en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - PowerPoint en la Web - PowerPoint en iPad - PowerPoint en Mac - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
Admite salida al formato Office Open XML (OOXML) como una matriz de bytes (Office.FileType.Compressed) cuando se usa el método Document.getFileAsync. |
CustomXmlParts
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en 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
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| Vea Conjuntos de requisitos de la API de cuadros de diálogo. | - UI.messageParent - UI.displayDialogAsync - UI.closeContainer -UI. Diálogo |
DialogOrigin
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| Consulte Conjuntos de requisitos de origen del cuadro de diálogo. | Compatibilidad entre dominios para: - UI.messageParent -UI. Dialog.messageChild |
DocumentEvents
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac - OneNote en la Web - PowerPoint en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - PowerPoint en la Web - PowerPoint en iPad - PowerPoint en Mac - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
- Document.addHandlerAsync - Document.removeHandlerAsync |
Archivo
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac - PowerPoint en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - PowerPoint en la Web - PowerPoint en iPad - PowerPoint en Mac - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
- Document.getFileAsync - File.closeAsync - File.getSliceAsync |
HtmlCoercion
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - OneNote en la Web - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
Admite la coerción a HTML (Office.CoercionType.Html) cuando se leen y escriben datos con los métodos Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync o Binding.setDataAsync. |
IdentityAPI
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| Vea Conjuntos de requisitos de la API de identidad. | - Auth.getAccessToken |
ImageCoercion
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| Vea Conjuntos de requisitos de coerción de imágenes. | - Document.setSelectedDataAsync |
KeyboardShortcuts
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| Consulte Conjuntos de requisitos de métodos abreviados de teclado. | - Office.actions.areShortcutsInUse - Office.actions.getShortcuts - Office.actions.replaceShortcuts |
Mailbox
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Outlook en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - nuevo Outlook en Windows (versión preliminar) - Outlook en la Web - Outlook en Android - Outlook en Mac - Outlook en iOS |
Consulte Información sobre los conjuntos de requisitos de la API de Outlook. |
MatrixBindings
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en la web - Word en iPad - Word en Mac |
- Bindings.addFromNamedItemAsync - Bindings.addFromSelectionAsync - Bindings.getAllAsync - Bindings.getByIdAsync - Bindings.releaseByIdAsync - Binding.getDataAsync - Binding.setDataAsync |
MatrixCoercion
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
Admite la coerción a la estructura de datos de "matrix" (matriz de matrices) (Office.CoercionType.Matrix) cuando se leen y escriben datos con los métodos Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync o Binding.setDataAsync. |
OoxmlCoercion
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
Admite la coerción al formato Open Office XML (OOXML) (Office.CoercionType.Ooxml) cuando se leen y escriben datos con los métodos Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync o Binding.setDataAsync. |
OpenBrowserWindowApi
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| Consulte Conjuntos de requisitos de Open Browser Window API. | - Office.context.ui.openBrowserWindow |
PartialTableBindings
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| Ninguno. |
PdfFile
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en Mac - PowerPoint en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - PowerPoint en la Web - PowerPoint en iPad - PowerPoint en Mac - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
Admite salida a formato PDF (Office.FileType.Pdf) al usar el método Document.getFileAsync. |
RibbonApi
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| Consulte Conjuntos de requisitos de la API de cinta de opciones. | - Office.ribbon.requestUpdate |
Selección
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac - PowerPoint en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - PowerPoint en la Web - PowerPoint en iPad - PowerPoint en Mac - Proyecto en Windows -- Licencia por volumen perpetua de Office 2013 - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
- Document.getSelectedDataAsync - Document.setSelectedDataAsync |
Configuración
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac - OneNote en la Web - PowerPoint en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - PowerPoint en la Web - PowerPoint en iPad - PowerPoint en Mac - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
- Settings.get - Settings.remove - Settings.saveAsync - Settings.set |
SharedRuntime
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| Consulte Conjuntos de requisitos de tiempo de ejecución compartido. | - 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
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
- Bindings.addFromNamedItemAsync - Bindings.addFromSelectionAsync - Bindings.getAllAsync - Bindings.getByIdAsync - Bindings.releaseByIdAsync - Binding.addColumnsAsync - Binding.addRowsAsync - Binding.deleteAllDataValuesAsync - Binding.getDataAsync - Binding.setDataAsync |
TableCoercion
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
Admite la coerción a la estructura de datos de "table" (Office.CoercionType.Table) cuando se leen y escriben datos con los métodos Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync o Binding.setDataAsync. |
TextBindings
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
- Bindings.addFromNamedItemAsync - Bindings.addFromSelectionAsync - Bindings.getAllAsync - Bindings.getByIdAsync - Bindings.releaseByIdAsync - Binding.getDataAsync - Binding.setDataAsync |
TextCoercion
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - OneNote en la Web - PowerPoint en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - PowerPoint en la Web - PowerPoint en iPad - PowerPoint en Mac - Proyecto en Windows -- Licencia por volumen perpetua de Office 2013 - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
Admite la coerción al formato de texto (Office.CoercionType.Text) cuando se leen y escriben datos con los métodos Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync o Binding.setDataAsync. |
TextFile
| Compatibilidad mínima con aplicaciones de Office | Métodos del conjunto |
|---|---|
| - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en Mac - Word en la web - Word en iPad |
Admite salida en formato de texto (Office.FileType.Text) cuando se usa el método Document.getFileAsync. |
Métodos no incluidos en un conjunto de requisitos
Los métodos siguientes de la API de JavaScript de Office no forman parte de un conjunto de requisitos. Si el complemento requiere cualquiera de estos métodos, use los <elementos Methods> y <Method> del manifiesto del complemento para declarar que son necesarios o realizar la comprobación en tiempo de ejecución mediante una if instrucción . Para obtener más información, vea Especificar aplicaciones de Office y requisitos de API.
| Nombre del método | Compatibilidad mínima con aplicaciones de Office |
|---|---|
| Bindings.addFromPromptAsync | - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac |
| Document.getFilePropertiesAsync | - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac - PowerPoint en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - PowerPoint en la Web - PowerPoint en iPad - PowerPoint en Mac - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en la web - Word en iPad - Word en Mac |
| Document.getProjectFieldAsync | - Project Standard 2013 - Project Profesional 2013 |
| Document.getResourceFieldAsync | - Project Standard 2013 - Project Profesional 2013 |
| Document.getSelectedResourceAsync | - Project Standard 2013 - Project Profesional 2013 |
| Document.getSelectedTaskAsync | - Project Standard 2013 - Project Profesional 2013 |
| Document.getSelectedViewAsync | - Project Standard 2013 - Project Profesional 2013 |
| Document.getTaskAsync | - Project Standard 2013 - Project Profesional 2013 |
| Document.getTaskFieldAsync | - Project Standard 2013 - Project Profesional 2013 |
| Document.goToByIdAsync | - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac - PowerPoint en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - PowerPoint en la Web - PowerPoint en iPad - PowerPoint en Mac - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en la web - Word en iPad - Word en Mac |
| Settings.addHandlerAsync | - Excel en la Web |
| Settings.refreshAsync | - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - PowerPoint en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - PowerPoint en la Web - Word en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Word en la web |
| Settings.removeHandlerAsync | - Excel en la Web |
| TableBinding.clearFormatsAsync | - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac |
| TableBinding.setFormatsAsync | - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac |
| TableBinding.setTableOptionsAsync | - Excel en Windows -- Suscripción a Microsoft 365 -- Perpetuo Office 2013 - Excel en la Web - Excel en iPad - Excel en Mac |
Vea también
Colaborar con nosotros en GitHub
El origen de este contenido se puede encontrar en GitHub, donde también puede crear y revisar problemas y solicitudes de incorporación de cambios. Para más información, consulte nuestra guía para colaboradores.
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de