Обзор надстроек WordWord add-ins overview

Хотите создать решение для автоматического составления документов или привязки и доступа к данным в документе Word из других источников? Чтобы расширить возможности клиентов Word на компьютере с Windows, Mac или в облаке, используйте платформу надстроек Office, которая включает API JavaScript для Word и API JavaScript для Office.Do you want to create a solution that extends the functionality of Word? For example, one that involves automated document assembly? Or a solution that binds to and accesses data in a Word document from other data sources? You can use the Office Add-ins platform, which includes the Word JavaScript API and the JavaScript API for Office, to extend Word clients running on a Windows desktop, on a Mac, or in the cloud.

На платформе надстроек Office можно разрабатывать не только надстройки Word. Используя команды надстроек, вы можете расширять интерфейс Word и запускать области задач, которые выполняют сценарий JavaScript, взаимодействующий с содержимым документа. Любой код, который работает в браузере, будет работать в надстройке Word. Надстройки, взаимодействующие с содержимым документа Word, создают запросы на совершение действий с объектами Word и синхронизацию состояния этих объектов.Word add-ins are one of the many development options that you have on the Office Add-ins platform. You can use add-in commands to extend the Word UI and launch task panes that run JavaScript that interacts with the content in a Word document. Any code that you can run in a browser can run in a Word add-in. Add-ins that interact with content in a Word document create requests to act on Word objects and synchronize object state.

Примечание

Если вы планируете опубликовать надстройку в AppSource, она должна соответствовать политикам проверки AppSource. Например, чтобы пройти проверку, надстройка должна работать на всех платформах, поддерживающих определенные вами методы. Дополнительные сведения см. в разделе 4.12 и статье о доступности надстроек Office в ведущих приложениях.When you build your add-in, if you plan to publish your add-in to AppSource, make sure that you conform to the AppSource validation policies. For example, to pass validation, your add-in must work across all platforms that support the methods that you define (for more information, see section 4.12 and the Office Add-in host and availability page).

Ниже показан пример надстройки Word, работающей в области задач.The following figure shows an example of a Word add-in that runs in a task pane.

Рис. 1. Надстройка, работающая в области задач WordFigure 1. Add-in running in a task pane in Word

Надстройка, работающая в области задач Word

Надстройка Word может (1) отправлять запросы в документ Word и (2) обновлять, удалять или перемещать абзац, используя JavaScript для доступа к объекту paragraph. Например, в приведенном ниже коде показано, как добавить в абзац новое предложение.The Word add-in (1) can send requests to the Word document (2) and can use JavaScript to access the paragraph object and update, delete, or move the paragraph. For example, the following code shows how to append a new sentence to that paragraph.

Word.run(function (context) {
    var paragraphs = context.document.getSelection().paragraphs;
    paragraphs.load();
    return context.sync().then(function () {
        paragraphs.items[0].insertText(' New sentence in the paragraph.',
                                       Word.InsertLocation.end);
    }).then(context.sync);
});

Для размещения надстройки Word можно использовать любой веб-сервер, в частности ASP.NET, NodeJS и Python. Используйте любимую клиентскую платформу — Ember, Backbone, Angular, React —для разработки своего решения; или продолжайте работу с VanillaJS. Для аутентификации и размещения приложения можно использовать Azure.You can use any web server technology to host your Word add-in, such as ASP.NET, NodeJS, or Python. Use your favorite client-side framework -- Ember, Backbone, Angular, React -- or stick with VanillaJS to develop your solution, and you can use services like Azure to authenticate and host your application.

API JavaScript для Word предоставляют приложению доступ к объектам и метаданным документа Word. С помощью этих API можно создавать надстройки, предназначенные для:The Word JavaScript APIs give your application access to the objects and metadata found in a Word document. You can use these APIs to create add-ins that target:

  • Word 2013 или более поздней версии для WindowsWord 2013 or later on Windows
  • Word в ИнтернетеOutlook on the web
  • Word 2016 или более поздней версии для MacWord 2016 or later for Mac
  • Word для iPadWord on iPad

Написанные вами надстройки будут работать во всех версиях Word на различных платформах. Дополнительные сведения см. в статье Доступность ведущих приложений и платформ для надстроек Office.Write your add-in once, and it will run in all versions of Word across multiple platforms. For details, see Office Add-in host and platform availability.

API JavaScript для WordJavaScript APIs for Word

Для взаимодействия с объектами и метаданными в документе Word можно использовать два набора API JavaScript.You can use two sets of JavaScript APIs to interact with the objects and metadata in a Word document. Первый — общий API, представленный в Office 2013.The first is the Common API, which was introduced in Office 2013. Многие объекты общего API можно использовать в надстройках, размещенных в двух или более клиентах Office.Many of the objects in the Common API can be used in add-ins hosted by two or more Office clients. В этом API широко используются обратные вызовы.This API uses callbacks extensively.

Второй — API JavaScript для Word. Это строго типизированная объектная модель, с помощью которой можно создавать надстройки Word, предназначенные для Word 2016 для Mac и Windows. Эта объектная модель использует обещания и предоставляет доступ к объектам Word, в частности Body, ContentControl, InlinePicture и Paragraph. API JavaScript для Word включает определения TypeScript и файлы vsdoc, чтобы вы могли получать подсказки кода в своей интегрированной среде разработки.The second is the Word JavaScript API. This is a strongly-typed object model that you can use to create Word add-ins that target Word 2016 for Mac and Windows. This object model uses promises, and provides access to Word-specific objects like body, content controls, inline pictures, and paragraphs. The Word JavaScript API includes TypeScript definitions and vsdoc files so that you can get code hints in your IDE.

В настоящее время все клиенты Word поддерживают общий API JavaScript для Office, а большинство из них поддерживают и API JavaScript для Word. Дополнительные сведения о поддерживаемых клиентах см. в справочнике по API.Currently, all Word clients support the shared JavaScript API for Office, and most clients support the Word JavaScript API. For details about supported clients, see the API reference documentation.

Рекомендуем начать с API JavaScript для Word, так как с объектной моделью проще работать. Используйте API JavaScript для Word, если вам нужно:We recommend that you start with the Word JavaScript API because the object model is easier to use. Use the Word JavaScript API if you need to:

  • получить доступ к объектам в документе Word.Access the objects in a Word document.

Используйте общий API JavaScript для Office, если вам нужно:Use the shared JavaScript API for Office when you need to:

  • создать надстройки для Word 2013;Target Word 2013.
  • выполнить начальные действия для приложения;Perform initial actions for the application.
  • проверить поддерживаемый набор требований;Check the supported requirement set.
  • получить доступ к метаданным документа, его параметрам и сведениям о среде;Access metadata, settings, and environmental information for the document.
  • создать привязку к разделам документа и записать события;Bind to sections in a document and capture events.
  • использовать пользовательские XML-части;Use custom XML parts.
  • открыть диалоговое окно.Open a dialog box.

Дальнейшие действияNext steps

Готовы создать свою первую надстройку Word? Используйте манифест надстройки, чтобы указать ведущее приложение, имя, разрешения и другие сведения.Ready to create your first Word add-in? See Build your first Word add-in. You can also try our interactive Get started experience. Use the add-in manifest to describe where your add-in is hosted, how it is displayed, and define permissions and other information.

Чтобы узнать больше о том, как создать качественную и привлекательную надстройку Word, см. руководство по разработке и рекомендации.To learn more about how to design a world class Word add-in that creates a compelling experience for your users, see Design guidelines and Best practices.

После разработки надстройку можно опубликовать в сетевой папке, каталоге приложений или AppSource.After you develop your add-in, you can publish it to a network share, an app catalog, or AppSource.

См. такжеSee also