Наборы обязательных элементов общего API для Office
Наборы требований — это именованные группы элементов API. Надстройки Office с помощью наборов обязательных элементов, указанных в манифесте, или проверки в среде выполнения определяют, поддерживает ли клиентское приложение Office необходимые API. Дополнительные сведения см. в разделе Версии Office и наборы требований.
Совет
Ищете наборы требований API для конкретного приложения ? См. следующие наборы обязательных элементов API.
- Наборы обязательных элементов API JavaScript для Excel (ExcelApi)
- Наборы обязательных элементов API JavaScript для Word (WordApi)
- Наборы обязательных элементов API JavaScript для OneNote (OneNoteApi)
- Наборы обязательных элементов PowerPoint JavaScript API (PowerPointApi)
- Общие сведения о наборах обязательных элементов API Outlook (MailBox)
Наборы обязательных элементов общего API
В следующих разделах перечислены наборы общих требований API, методы в каждом наборе и клиентские приложения Office, поддерживающие этот набор требований. Все эти наборы обязательных элементов API имеют версию 1.1, если не указано иное.
Совет
Нужна информация о том, где надстройки и наборы требований поддерживаются приложением и версией Office? См. статью Доступность клиентских приложений и платформ Office для надстроек Office.
ActiveView
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — PowerPoint в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — PowerPoint в Интернете — PowerPoint на iPad — PowerPoint на Mac |
— Document.getActiveViewAsync |
AddInCommands
См. статью Наборы обязательных элементов для команд надстроек.
BindingEvents
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
— Binding.addHandlerAsync — Binding.removeHandlerAsync |
CompressedFile
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Excel в Windows Подписка На Microsoft 365 -- Office 2016 с бессрочным сроком 2016 — Excel в Интернете — Excel на Mac — PowerPoint в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — PowerPoint в Интернете — PowerPoint на iPad — PowerPoint на Mac — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
Поддерживает вывод в формате Office Open XML (OOXML) в виде байтового массива (Office.FileType.Compressed) при использовании метода Document.getFileAsync. |
CustomXmlParts
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на 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
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| См. статью Наборы обязательных элементов API диалоговых окон. | — UI.messageParent — UI.displayDialogAsync — UI.closeContainer -ПОЛЬЗОВАТЕЛЬСКОГО ИНТЕРФЕЙСА. Диалог |
DialogOrigin
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| См . раздел Наборы обязательных элементов источника диалогового окна. | Междоменная поддержка для: — UI.messageParent -ПОЛЬЗОВАТЕЛЬСКОГО ИНТЕРФЕЙСА. Dialog.messageChild |
DocumentEvents
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac — OneNote в Интернете — PowerPoint в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — PowerPoint в Интернете — PowerPoint на iPad — PowerPoint на Mac — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
— Document.addHandlerAsync — Document.removeHandlerAsync |
File
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac — PowerPoint в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — PowerPoint в Интернете — PowerPoint на iPad — PowerPoint на Mac — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
— Document.getFileAsync — File.closeAsync — File.getSliceAsync |
HtmlCoercion
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — OneNote в Интернете — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
Поддерживает приведение в HTML (Office.CoercionType.Html) при чтении и записи данных с использованием методов Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync и Binding.setDataAsync. |
IdentityAPI
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| См. статью Наборы обязательных элементов API удостоверений. | - Auth.getAccessToken |
ImageCoercion
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| См. статью Наборы требований к приведению изображений. | — Document.setSelectedDataAsync |
KeyboardShortcuts
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| См . раздел Наборы обязательных наборов сочетаний клавиш. | — Office.actions.areShortcutsInUse — Office.actions.getShortcuts — Office.actions.replaceShortcuts |
Mailbox
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Outlook в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 - новый Outlook в Windows (предварительная версия) — Outlook в Интернете — Outlook на Android — Outlook на Mac — Outlook для iOS |
См. статью Общие сведения о наборах обязательных элементов API для Outlook. |
MatrixBindings
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word в Интернете — Word на iPad — Word на Mac |
— Bindings.addFromNamedItemAsync — Bindings.addFromSelectionAsync — Bindings.getAllAsync — Bindings.getByIdAsync — Bindings.releaseByIdAsync — Binding.getDataAsync — Binding.setDataAsync |
MatrixCoercion
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
Поддерживает приведение в структуру данных "матрица" (массив массивов, Office.CoercionType.Matrix) при чтении и записи данных с использованием методов Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync и Binding.setDataAsync. |
OoxmlCoercion
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
Поддерживает приведение в формат Open Office XML (OOXML, Office.CoercionType.Ooxml) при чтении и записи данных с использованием методов Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync и Binding.setDataAsync. |
OpenBrowserWindowApi
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| См . раздел Наборы обязательных элементов API окна в браузере. | — Office.context.ui.openBrowserWindow |
PartialTableBindings
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| Нет. |
PdfFile
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на Mac — PowerPoint в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — PowerPoint в Интернете — PowerPoint на iPad — PowerPoint на Mac — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
Поддерживает вывод в формате PDF (Office.FileType.Pdf) при использовании метода Document.getFileAsync. |
RibbonApi
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| См . раздел Наборы обязательных элементов API ленты. | — Office.ribbon.requestUpdate |
Selection
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac — PowerPoint в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — PowerPoint в Интернете — PowerPoint на iPad — PowerPoint на Mac — Project в Windows -- Корпоративный бессрочный Office 2013 — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
— Document.getSelectedDataAsync — Document.setSelectedDataAsync |
Параметры
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac — OneNote в Интернете — PowerPoint в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — PowerPoint в Интернете — PowerPoint на iPad — PowerPoint на Mac — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
— Settings.get — Settings.remove — Settings.saveAsync — Settings.set |
SharedRuntime
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| См. раздел Общие наборы обязательных элементов среды выполнения. | — 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
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
— Bindings.addFromNamedItemAsync — Bindings.addFromSelectionAsync — Bindings.getAllAsync — Bindings.getByIdAsync — Bindings.releaseByIdAsync — Binding.addColumnsAsync — Binding.addRowsAsync — Binding.deleteAllDataValuesAsync — Binding.getDataAsync — Binding.setDataAsync |
TableCoercion
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
Поддерживает приведение в структуру данных "таблица" (Office.CoercionType.Table) при чтении и записи данных с использованием методов Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync и Binding.setDataAsync. |
TextBindings
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
— Bindings.addFromNamedItemAsync — Bindings.addFromSelectionAsync — Bindings.getAllAsync — Bindings.getByIdAsync — Bindings.releaseByIdAsync — Binding.getDataAsync — Binding.setDataAsync |
TextCoercion
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — OneNote в Интернете — PowerPoint в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — PowerPoint в Интернете — PowerPoint на iPad — PowerPoint на Mac — Project в Windows -- Корпоративный бессрочный Office 2013 — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
Поддерживает приведение в текстовый формат (Office.CoercionType.Text) при чтении и записи данных с использованием методов Document.getSelectedDataAsync, Document.setSelectedDataAsync, Binding.getDataAsync и Binding.setDataAsync. |
TextFile
| Минимальная поддержка приложений Office | Методы в наборе |
|---|---|
| — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word на Mac — Word в Интернете — Word на iPad |
Поддерживает вывод в текстовом формате (Office.FileType.Text) при использовании метода Document.getFileAsync. |
Методы, отсутствующие в наборе требований
Следующие методы в API JavaScript для Office не входят в набор обязательных элементов. Если надстройке требуется какой-либо из этих методов, используйте <элементы Methods> и <Method> в манифесте надстройки, чтобы объявить, что они необходимы, или выполнить проверка среды выполнения с помощью инструкции if . Дополнительные сведения см . в разделе Указание приложений Office и требований к API.
| Имя метода | Минимальная поддержка приложений Office |
|---|---|
| Bindings.addFromPromptAsync | — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac |
| Document.getFilePropertiesAsync | — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac — PowerPoint в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — PowerPoint в Интернете — PowerPoint на iPad — PowerPoint на Mac — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word в Интернете — Word на iPad — Word на Mac |
| Document.getProjectFieldAsync | - Project стандартный 2013 - Project профессиональный 2013 г. |
| Document.getResourceFieldAsync | - Project стандартный 2013 - Project профессиональный 2013 г. |
| Document.getSelectedResourceAsync | - Project стандартный 2013 - Project профессиональный 2013 г. |
| Document.getSelectedTaskAsync | - Project стандартный 2013 - Project профессиональный 2013 г. |
| Document.getSelectedViewAsync | - Project стандартный 2013 - Project профессиональный 2013 г. |
| Document.getTaskAsync | - Project стандартный 2013 - Project профессиональный 2013 г. |
| Document.getTaskFieldAsync | - Project стандартный 2013 - Project профессиональный 2013 г. |
| Document.goToByIdAsync | — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac — PowerPoint в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — PowerPoint в Интернете — PowerPoint на iPad — PowerPoint на Mac — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word в Интернете — Word на iPad — Word на Mac |
| Settings.addHandlerAsync | — Excel в Интернете |
| Settings.refreshAsync | — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — PowerPoint в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — PowerPoint в Интернете — Word в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Word в Интернете |
| Settings.removeHandlerAsync | — Excel в Интернете |
| TableBinding.clearFormatsAsync | — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac |
| TableBinding.setFormatsAsync | — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac |
| TableBinding.setTableOptionsAsync | — Excel в Windows Подписка На Microsoft 365 -- Office 2013 с бессрочным сроком 2013 — Excel в Интернете — Excel на iPad — Excel на Mac |
См. также
Совместная работа с нами на GitHub
Источник этого содержимого можно найти на GitHub, где также можно создавать и просматривать проблемы и запросы на вытягивание. Дополнительные сведения см. в нашем руководстве для участников.
Office Add-ins
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по