Элемент Requirements

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

Совет

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

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

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

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

В качестве дочернего элемента элемента VersionOverrides

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

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

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

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

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

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

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

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

  • AddinCommands 1.1 , если родительским <параметром VersionOverrides> является тип области задач 1.0.
  • Почтовый ящик 1.3 , если родительское <значение VersionOverrides> имеет тип Mail 1.0.
  • Почтовый ящик 1.5 , если родительское <значение VersionOverrides> имеет тип Mail 1.1.

Примечания

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

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

Совет

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

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

Будьте очень осторожны перед использованием <элемента Requirements> в <VersionOverrides>, потому что на платформах и в комбинациях версий, не поддерживающих это требование, не будет установлена ни одна из команд надстроек, даже те, которые вызывают функцию, не требующую этого требования. Например, можно создать надстройку с двумя пользовательскими кнопками ленты. Один из них вызывает Office JavaScript API, которые доступны в наборе требований 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 всегда будет использовать самую последнюю версию<, поддерживаемую платформой и версией Office.>

В качестве дочернего элемента элемента Override

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

Содержится в

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

Элемент <"Требования"> может содержать указанные ниже дочерние элементы в зависимости от типа надстройки.

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

См. также

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

  • Last updated on