Обзор надстроек Word

  • Статья

Вы хотите создать решение, расширяющее функциональность Word? Например, автоматизированная сборка документов? Или решение, которое привязывается к данным в документе Word из других источников данных и обращается к ним? Вы можете использовать платформу надстроек Office, которая включает в себя API JavaScript Word и API JavaScript для Office, чтобы расширить Word клиентов, работающих на рабочем столе Windows, на компьютере Mac или в облаке.

На платформе надстроек Office можно разрабатывать не только надстройки Word. Используя команды надстроек, вы можете расширять интерфейс Word и запускать области задач, которые выполняют сценарий JavaScript, взаимодействующий с содержимым документа. Любой код, который работает в браузере, будет работать в надстройке Word. Надстройки, взаимодействующие с содержимым документа Word, создают запросы на совершение действий с объектами Word и синхронизацию состояния этих объектов.

Примечание.

Если вы планируете опубликовать надстройку в AppSource и Office, она должна соответствовать Политикам сертификации коммерческого рынка.  Например, она должна работать на всех платформах, поддерживающих определенные вами методы. Дополнительные сведения см. в разделе 1120.3 и на странице с информацией о доступности для платформ и приложений Office.

Ниже показан пример надстройки Word, работающей в области задач.

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

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

Надстройка Word может выполнять следующие действия.

  1. Отправка запросов в документ Word.
  2. Используйте JavaScript для доступа к объекту абзаца и обновления, удаления или перемещения абзаца.

Например, в приведенном ниже коде показано, как добавить в абзац новое предложение.

await Word.run(async (context) => {
    const paragraphs = context.document.getSelection().paragraphs;
    paragraphs.load();
    await context.sync();
    paragraphs.items[0].insertText(' New sentence in the paragraph.',
                                       Word.InsertLocation.end);
    await context.sync();
});

Для размещения надстройки Word можно использовать любую технологию веб-сервера, например ASP.NET, NodeJS или Python. Используйте любимую клиентскую платформу — Ember, Магистраль, Angular, React — или придерживайтесь ванильного или простого JavaScript для разработки решения. Вы также можете использовать такие службы, как Azure, для проверки подлинности и размещения приложения.

API JavaScript для Word предоставляют приложению доступ к объектам и метаданным документа Word. С помощью этих API можно создавать надстройки, предназначенные для:

  • Word 2016 или более поздней версии в Windows
  • Word в Интернете
  • Word 2016 или более поздней версии для Mac
  • Word для iPad

Напишите надстройку один раз, и она будет запускаться во всех версиях Word на нескольких платформах. Дополнительные сведения см. в статье Доступность клиентских приложений и платформ Office для надстроек Office.

API JavaScript для Word

Для взаимодействия с объектами и метаданными в документе Word можно использовать два набора API JavaScript. Первый — общий API, представленный в Office 2013. Многие объекты общего API можно использовать в надстройках, размещенных в двух или более клиентах Office. В этом API широко используются обратные вызовы.

Второй — API JavaScript для Word. Это модель API для конкретных приложений, которая была представлена в Word 2016. Это строго типизированная объектная модель, которую можно использовать для создания Word надстроек, предназначенных для Word 2016 и более поздних версий на Компьютере Mac и в Windows. Эта объектная модель использует обещания и предоставляет доступ к Word объектам, таким как текст, элементы управления содержимым, встроенные изображения и абзацы. API JavaScript для Word включает определения TypeScript и файлы vsdoc, чтобы вы могли получать подсказки кода в своей интегрированной среде разработки.

В настоящее время все клиенты Word поддерживают общий API JavaScript для Office, а большинство из них поддерживают и API JavaScript для Word. Дополнительные сведения о поддерживаемых клиентах см. в статье Доступность клиентских приложений и платформ Office для надстроек Office

Рекомендуем начать с API JavaScript для Word, так как с объектной моделью проще работать. Используйте API JavaScript Word, если вам нужно сделать следующее:

  • получить доступ к объектам в документе Word.

Используйте общий API JavaScript для Office, если необходимо выполнить одно из следующих действий:

  • выполнить начальные действия для приложения;
  • проверить поддерживаемый набор требований;
  • получить доступ к метаданным документа, его параметрам и сведениям о среде;
  • создать привязку к разделам документа и записать события;
  • открыть диалоговое окно.

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

Готовы создать свою первую надстройку Word? См. статью Создание первой надстройки Word. Используйте манифест надстройки , чтобы описать, где размещена надстройка, как она отображается, а также определить разрешения и другие сведения.

Дополнительные сведения о разработке надстройки Word мирового уровня, которая создает привлекательный интерфейс для пользователей, см. в статье Рекомендации по проектированию и рекомендации.

После разработки надстройку можно опубликовать в сетевой папке, каталоге приложений или AppSource.

См. также