Элемент Requirements

  • Статья

Значение этого элемента зависит от того, используется ли он в базовом манифесте, как дочерний <элемент элемента VersionOverrides> или как дочерний элемент элемента Override.

Совет

Прежде чем использовать этот элемент, ознакомьтесь с указанием узлов Office и требований к API.

В базовом манифесте

При использовании в базовом манифесте (то есть в качестве прямого дочернего элемента OfficeApp) <элемент Requirements> указывает минимальный набор требований к API JavaScript для Office (наборы требований и/или методы), которые необходимо активировать вашей надстройке Office. Надстройка не будет активирована в любом сочетании версий Office и платформы (таких как Windows, Mac, Веб и iOS или iPad), которые не поддерживают указанные методы и наборы требований.

Тип надстройки: Область задач, почта

Дочерний элемент элемента VersionOverrides

При использовании в качестве дочернего элемента VersionOverrides задает минимальный набор требований к API JavaScript Для Office (наборы требований и(или) методы), которые должны поддерживаться версией и платформой Office (например, Windows, Mac, Web и iOS или iPad), чтобы параметры элемента <VersionOverrides>, переопределяющие базовые параметры манифеста, вступают в силу.

Рассмотрим надстройку, которая указывает требование A в базовом манифесте и требование B внутри <VersionOverrides>.

  • Если платформа и версия Office не поддерживают A, надстройка не активируется и Office не анализирует <раздел VersionOverrides> манифеста.
  • Если поддерживаются как A, так и B, то надстройка активируется, и вступает в силу вся разметка <в VersionOverrides> .
  • Если A поддерживается, а B — нет, то надстройка активируется, и некоторые из разметки в VersionOverrides> вступает в< силу. В частности, вступают в силу дочерние <элементы VersionOverrides> , которые не переопределяют базовые элементы манифеста. Например, вступают в <силу элементы WebApplicationInfo> или <EquivalentAddins> . Однако все дочерние <элементы VersionOverrides> , которые переопределяют базовый элемент манифеста, например <Hosts>, не вступают в силу. Вместо этого Office использует значения базовой разметки манифеста, которые в противном случае были бы переопределены.

Тип надстройки: Область задач, почта

Допустимо только в следующих схемах VersionOverrides:

  • Область задач 1.0
  • Почта 1.0
  • Почта 1.1

Дополнительные сведения см. в разделе Переопределения версий в манифесте.

Связаны с этими наборами требований:

Замечания

Элемент <Requirements> не служит никакой <цели в VersionOverrides>, если он не указывает никаких дополнительных требований, которые не указаны в требованиях> в базовом< манифесте. Если версия и платформа Office не поддерживают требования в базовом манифесте, надстройка не активируется, а <элемент VersionOverrides> не анализируется. По этой причине элемент Requirements> следует использовать< в <VersionOverrides> только при выполнении обоих следующих условий:

  • Надстройка имеет дополнительные функции, которые реализованы с конфигурацией в <VersionOverrides> (например, команды надстройки) и для которых требуется метод или набор требований, которые не указаны в элементе Requirements> в базовом< манифесте.
  • Ваша надстройка полезна и должна быть активирована (но без дополнительных функций), даже в сочетании платформы и версии Office, которая не поддерживает требования, необходимые для дополнительных функций.

Совет

Не повторяйте элементы Requirement из базового манифеста <внутри VersionOverrides>. Это не оказывает влияния и может ввести в заблуждение назначение <элемента Requirements> внутри <VersionOverrides>.

Предупреждение

Будьте внимательны перед использованием <элемента Requirements> в <VersionOverrides>, так как в сочетаниях платформ и версий, которые не поддерживают требование, ни одна из команд надстроек не будет установлена, даже те, которые вызывают функции, для которых не требуется требование. Рассмотрим, например, надстройку с двумя настраиваемыми кнопками ленты. Один из них вызывает API JavaScript для Office, доступные в наборе требований ExcelApi 1.4 (и более поздних версий). Другие вызывают API, доступные только в ExcelApi 1.9 (и более поздних версиях). Если вставить требование для ExcelApi 1.9 в <versionOverrides>, то если версия 1.9 не поддерживается, на ленте не появится ни кнопка. Лучшей стратегией в этом сценарии было бы использование метода, описанного в разделе Проверка среды выполнения для поддержки метода и набора требований. Код, вызываемый второй кнопкой, сначала используется isSetSupported для проверки поддержки ExcelApi 1.9. Если она не поддерживается, код предоставляет пользователю сообщение о том, что эта функция надстройки недоступна в его версии Office.

Примечание.

В почтовых надстройках можно <вложить VersionOverrides> 1.1 в версию< VersionOverrides> 1.0. Office всегда будет использовать версию VersionOverrides> с наивысшей версией<, поддерживаемую платформой и версией Office.

Как дочерний элемент элемента Override

Элемент <Requirements> может быть дочерним элементом элемента Override в контексте элемента-предка ExtendedOverrides . Элемент <Override> выражает условное выражение и может быть прочитан как "Если... тогда ..." Заявление. Если элемент Override> имеет тип RequirementsTokenOverride (это означает, что его родительский элемент Token имеет значение ), то дочерний элемент Requirements выражает условие, а атрибут является последующим<.><ValueRequirementsTokenxsi:type Например, первое< переопределение> в следующем: "Если текущая платформа поддерживает FeatureOne версии 1.7, используйте строку "oldAddinVersion" вместо ${token.requirements} маркера в URL-адресе бабушки и дедушки <ExtendedOverrides> (вместо строки обновления по умолчанию)." Дополнительные сведения см. в разделе ExtendedOverrides.

<ExtendedOverrides Url="http://contoso.com/addinmetadata/${token.requirements}/extended-manifest-overrides.json">
    <Tokens>
        <Token Name="requirements" DefaultValue="upgrade" xsi:type="RequirementsToken">
            <Override Value="oldAddinVersion">
                <Requirements>
                    <Sets>
                        <Set Name="FeatureOne" MinVersion="1.7" />
                    </Sets>
                </Requirements>
            </Override>
            <Override Value="currentAddinVersion">
                <Requirements>
                    <Sets>
                        <Set Name="FeatureOne" MinVersion="1.8" />
                    </Sets>
                    <Methods>
                        <Method Name="MethodThree" />
                    </Methods>
                </Requirements>
            </Override>
        </Token>
    </Tokens>
</ExtendedOverrides>

Тип надстройки: надстройки области задач

Синтаксис

<Requirements>
   ...
</Requirements>

Содержится в

Может содержать

Элемент <Requirements> может содержать следующие дочерние элементы в зависимости от типа надстройки.

Элемент Контентная Почта Область задач
Sets Да Да Да
Методы Да Нет Да

См. также

Дополнительные сведения о наборах обязательных элементов см. в статье Версии Office и наборы обязательных элементов.