Команды надстроек

Команды надстроек — это элементы, которые расширяют пользовательский интерфейс Office и запускают действия в надстройке. Команды надстроек можно использовать для добавления кнопки на ленту или элемента в контекстное меню. Когда пользователи выбирают команду надстройки, они инициируют действия, такие как запуск кода JavaScript или отображение страницы надстройки в области задач. Команды надстройки помогают пользователям находить и использовать вашу надстройку, что может повысить показатель внедрения надстройки и коэффициент удержания клиентов.

Примечание.

• Каталоги SharePoint не поддерживают команды надстроек. Развернуть их можно с помощью интегрированных приложений или AppSource. Чтобы развернуть команду надстройки для тестирования, используйте загрузку неопубликованного приложения.
• Контентные надстройки на данный момент не поддерживают команды надстроек.

Типы команд надстроек

Существует два типа команд надстроек, основанных на типе действия, активируемого командой.

• Команды области задач. Кнопка или пункт меню открывает область задач надстройки. Этот тип команды надстройки добавляется с разметкой в манифесте. "Код программной части" команды предоставляется Office.
• Команды функций: кнопка или элемент меню запускает любой произвольный JavaScript. Код почти всегда вызывает API в библиотеке JavaScript для Office, но это не обязательно. Этот тип надстройки обычно не отображает пользовательский интерфейс, кроме самой кнопки или элемента меню. Обратите внимание на следующие сведения о командах функций:
  • Запущенная функция может вызвать метод displayDialogAsync для отображения диалогового окна, что является хорошим способом отобразить ошибку, показать прогресс или запросить ввод от пользователя. Если надстройка настроена для использования общей среды выполнения, функция также может вызвать метод showAsTaskpane .
  • Среда выполнения, в которой выполняется команда функции, представляет собой полную среду выполнения на основе браузера. Она может отображать HTML и обращаться к Интернету для отправки или получения данных.

Расположение команд надстроек

Когда пользователь устанавливает надстройку, расположение ее команд зависит от приложения, платформы и контекста. Команды надстройки находятся на ленте, на вкладке по умолчанию или пользовательской вкладке или на панели действий (применяется только к определенным платформам Outlook). Они отображаются в пользовательском интерфейсе в виде кнопки или элемента в раскрывающемся меню.

Для команд надстроек, отображаемых на ленте, если вы используете упрощенный макет ленты, имя надстройки удаляется из панели приложения. Остается только командная кнопка надстройки на ленте.

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

Excel, PowerPoint и Word

Вкладка по умолчанию зависит от приложения и контекста. Для Excel, PowerPoint и Word по умолчанию используется вкладка Главная.

Outlook

Для Outlook расположение команды надстройки по умолчанию основано на платформе и текущем режиме Outlook. Инструкции см. в статье Использование надстроек в Outlook.

Раскрывающееся меню

Команда надстройки с раскрывающимся меню определяет статический список элементов. Меню может содержать любой набор элементов, которые выполняют функцию или открывают область задач. Подменю не поддерживаются.

Возможности команд

В настоящее время поддерживаются указанные ниже возможности команд.

Точки расширения

• Вкладки ленты — расширение встроенных вкладок или создание настраиваемой вкладки. Надстройка может содержать только одну настраиваемую вкладку.
• Контекстные меню: расширение возможностей выбранных контекстных меню.

Типы элементов управления

• Простые кнопки, запускающие определенные действия.
• Простые раскрывающиеся меню с кнопками, которые запускают действия.

Состояние по умолчанию: "Включено" или "Отключено"

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

Примечание.

Эта функция поддерживается не во всех приложениях и сценариях Office. Дополнительные сведения см. в статье о Включение и отключение команд надстроек.

Расположение на ленте (предварительная версия)

Вы можете указать, где настраиваемая вкладка будет отображаться на ленте приложения Office, например "справа от вкладки «Главная»".

Примечание.

Эта функция поддерживается не во всех приложениях и сценариях Office. Дополнительные сведения см. в статье Расположение настраиваемой вкладки на ленте.

Интеграция встроенных кнопок Office

Вы можете вставлять встроенные кнопки ленты Office в свои группы настраиваемых команд и настраиваемую вкладку ленты.

Примечание.

Эта функция поддерживается не во всех приложениях и сценариях Office. Дополнительные сведения см. в статье Интеграция встроенных кнопок Office в настраиваемые вкладки.

контекстные вкладки;

Вы можете настроить отображение вкладки на ленте только в определенных контекстах, например при выборе диаграммы в Excel.

Примечание.

Эта функция поддерживается не во всех приложениях и сценариях Office. Дополнительные сведения см. в статье Создание пользовательских контекстных вкладок в надстройках Office.

Поддерживаемые платформы

В настоящее время команды надстроек поддерживаются на следующих платформах (за исключением ограничений, указанных в подразделах Возможности команд ранее).

• Office в Интернете
• Office для Windows (версия 1604 (сборка 6769.2000) или более поздняя, подключенная к подписке Microsoft 365)
• Office для Mac (версия 15.33 (17040900) или более поздняя, подключенная к подписке Microsoft 365)
• Бессрочный Office 2019 или более поздней версии в Windows или на Mac

Примечание.

Сведения о поддержке в Outlook см. в заметках о поддержке Outlook.

Отладка

Чтобы выполнить отладку команды надстройки, ее необходимо выполнить в Office в Интернете. Дополнительные сведения см. в статье Отладка надстроек в Office в Интернете

Рекомендации

При разработке надстроек придерживайтесь следующих рекомендаций.

• Каждая команда должна представлять определенное действие с очевидным и конкретным исходом для пользователей. Не объединяйте несколько действий в одной кнопке.

• Предоставляйте точные действия, которые делают выполнение распространенных задач в надстройке более эффективным. Максимально сократите количество шагов, необходимых для выполнения действия.

• Расположение команд на ленте приложения Office:

  • Разместите команды на существующей вкладке (вставка, проверка и т. д.), если предусмотрена функциональность. Например, если надстройка позволяет пользователям вставлять мультимедиа, добавьте группу на вкладку Вставка. Обратите внимание, что не все вкладки доступны во всех версиях Office. Дополнительные сведения см. в разделе Манифест надстроек Office.
  • Добавляйте команды на вкладку "Главная", если соответствующие функции не относятся к другим вкладкам и надстройка содержит менее шести команд верхнего уровня. Вы также можете добавить команды на вкладку Главная, если надстройка должна работать в разных версиях Office (например, Office в Интернете или настольном компьютере), а вкладка доступна не во всех версиях (например, вкладка Конструктор не существует в Office в Интернете).
  • Добавляйте команды на пользовательскую вкладку, если надстройка содержит более шести команд верхнего уровня.
  • Название группы должно соответствовать названию надстройки. Если у вас есть несколько групп, их имена должны быть связаны с функциями, которые выполняют команды из этих групп.
  • Не добавляйте ненужные кнопки, чтобы увеличить объем недвижимости надстройки.
  • Не расположите настраиваемую вкладку слева от вкладки Главная и не фокусируйте ее по умолчанию при открытии документа, если только надстройка не является основным способом взаимодействия пользователей с документом. Чрезмерное выделение вашей надстройки создает неудобства и раздражает пользователей и администраторов.
  • Если надстройка является основным способом взаимодействия пользователей с документом и у вас есть настраиваемая вкладка ленты, рассмотрите возможность интеграции кнопок во вкладку для применения функций Office, которые часто требуются пользователям.
  • Если функции, предоставляемые настраиваемой вкладкой, должны быть доступны только в определенных контекстах, используйте настраиваемые контекстные вкладки. Если вы используете настраиваемые контекстные вкладки, реализуйте резервный интерфейс, когда ваша надстройка запускается на платформах, не поддерживающих настраиваемые контекстные вкладки.

  Примечание.

  Надстройки, которые занимают слишком много места, могут не пройти проверку в AppSource.

• Руководство по оформлению значков подходит для всех значков.

• Укажите версию надстройки, которая работает в приложениях Office или платформах (например, iPad), которые не поддерживают команды. Для этих версий можно использовать один манифест надстройки.

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

Лучший способ начать работу с командами надстроек Office — ознакомиться с примерами на сайте GitHub.

Дополнительные сведения об указании команд надстройки в манифесте только надстройки см. в разделе Создание команд надстройки с помощью манифеста только надстройки и ссылочного содержимого VersionOverrides .

Дополнительные сведения об указании команд надстроек в унифицированном манифесте для Microsoft 365 см. в статье Создание команд надстроек с помощью унифицированного манифеста для Microsoft 365.