Élément Requirements

La signification de cet élément varie selon qu’il est utilisé dans le manifeste de base, en tant qu’enfant d’un <élément VersionOverrides> ou en tant qu’enfant de l’élément Override.

Conseil

Avant d’utiliser cet élément, familiarisez-vous avec les spécifications des hôtes Office et les exigences API

Dans le manifeste de base

Lorsqu’il est utilisé dans le manifeste de base (autrement dit, en tant qu’enfant direct d’OfficeApp), l’élément <Exigences> spécifie l’ensemble minimal de la configuration requise de l’API JavaScript Office (ensembles d’exigences et/ou méthodes) dont votre complément Office a besoin pour être activé par Office. Le complément ne sera activé sur aucune combinaison de version et de plateforme d’Office (Windows, Mac, web et iOS ou iPad, par exemple) qui ne prend pas en charge les méthodes et les ensembles de conditions requises spécifiés.

Type de complément : Volet Office, Courrier

En tant qu’enfant d’un élément VersionOverrides

Lorsqu’il est utilisé en tant qu’enfant de VersionOverrides, spécifie l’ensemble minimal de la configuration requise de l’API JavaScript Office (ensembles de conditions et /ou méthodes) qui doivent être pris en charge par la version et la plateforme Office (Windows, Mac, web et iOS ou iPad) pour que les paramètres de l’élément <VersionOverrides>qui remplacent les paramètres du manifeste de base prennent effet.

Envisagez un complément qui spécifie l’exigence A dans le manifeste de base et spécifie l’exigence B dans les <VersionOverrides>.

  • Si la plateforme et la version d’Office ne prennent pas en charge A, le complément n’est pas activé et Office n’analyse pas la <section VersionOverrides> du manifeste.
  • Si A et B sont pris en charge, le complément est activé et tout le balisage de VersionOverrides<> prend effet.
  • Si A est pris en charge, mais pas B, le complément est activé et une partie du balisage dans les <remplacements> de version prend effet. Plus précisément, les éléments enfants de VersionOverrides<> qui ne remplacent pas les éléments du manifeste de base prennent effet. Par exemple, un <élément WebApplicationInfo> ou un <EquivalentAddins> prend effet. Toutefois, tous les éléments enfants de VersionOverrides<> qui remplacent un élément de manifeste de base, tels que <les hôtes, ne prennent pas effet.> Office utilise à la place les valeurs du balisage de manifeste de base qui auraient été remplacées autrement.

Type de complément : Volet Office, Courrier

Valide uniquement dans ces schémas VersionOverrides :

  • Volet De tâches 1.0
  • Mail 1.0
  • Courrier 1.1

Pour plus d’informations, consultez Remplacements de version dans le manifeste du complément uniquement.

Associé à ces ensembles de conditions requises :

Remarques

L’élément <Requirements> ne sert à rien dans une <VersionOverrides> s’il ne spécifie aucune exigence supplémentaire qui n’est pas spécifiée dans une <exigence> dans le manifeste de base. Si la version et la plateforme Office ne prennent pas en charge les exigences du manifeste de base, le complément n’est pas activé et l’élément <VersionOverrides> n’est pas analysé. Pour cette raison, vous ne devez utiliser un <élément Requirements> dans un <VersionOverrides> que si ces deux conditions sont remplies :

  • Votre complément comporte des fonctionnalités supplémentaires qui sont implémentées avec la configuration d’un <VersionOverrides> (telles que des commandes de complément) et qui nécessitent une méthode ou un ensemble de conditions requises qui n’est pas spécifié dans un <élément Requirements> du manifeste de base.
  • Votre complément est utile et doit être activé (mais sans les fonctionnalités supplémentaires), même dans une combinaison de plateforme et de version d’Office qui ne prend pas en charge la configuration requise pour les fonctionnalités supplémentaires.

Conseil

Ne répétez pas les éléments d’exigence du manifeste de base dans un <VersionOverrides>. Cela n’a aucun effet et peut induire en erreur quant à l’objectif de l’élément <Requirements> à l’intérieur d’un <VersionOverrides>.

Avertissement

Soyez très prudent avant d’utiliser un <élément Requirements> dans un <VersionOverrides, car sur les combinaisons plate-forme et version qui ne prennent pas en charge l’exigence, aucune des commandes de complément n’est installée>, même celles qui appellent une fonctionnalité qui n’a pas besoin de l’exigence. Prenons l’exemple, d’un complément doté de deux boutons de ruban personnalisés. L’un d’eux appelle les API JavaScript Office disponibles dans le jeu de conditions requises ExcelApi 1.4 (et versions ultérieures). L’autre appelle des API qui ne sont disponibles que dans ExcelApi 1.9 (et versions ultérieures). Si vous définissez une exigence pour ExcelApi 1.9 dans VersionOverrides>, lorsque la version 1.9 n’est< pas prise en charge, aucun des deux boutons n’apparaît dans le ruban. Une meilleure stratégie dans ce scénario consiste à utiliser la technique décrite dans les vérifications d’exécution pour la prise en charge des méthodes et des ensembles d’exigences. Le code invoqué par le deuxième bouton est utilisé isSetSupported pour la première fois pour vérifier la prise en case activée d’ExcelApi 1.9. Si elle n’est pas prise en charge, le code fournit à l’utilisateur un message indiquant que cette fonctionnalité du complément n’est pas disponible sur sa version d’Office.

Remarque

Dans les compléments de messagerie, il est possible qu’une <version 1.1> soit imbriquée dans une <version 1.0> . Office utilisera toujours la version <la plus élevée (VersionOverrides> ) prise en charge par la plateforme et la version d’Office.

En tant qu’enfant de l’élément Override

Un <élément Requirements> peut être un enfant d’un élément Override dans le contexte d’un élément ExtendedOverrides ancêtre. Un <élément Override> exprime un conditionnel et peut être lu comme un « Si ... alors..." instruction factuelle. Si l’élément <Override> est de type RequirementTokenOverride (ce qui signifie que l’élément xsi:typeToken de son parent est RequirementsToken), alors l’élément Requirements> enfant< exprime la condition et l’attribut Value est la conséquence. Par exemple, le premier <remplacement> dans ce qui suit est le suivant : « Si la plate-forme actuelle prend en charge la version 1.7 de FeatureOne, utilisez la chaîne « oldAddinVersion » à la ${token.requirements} place du jeton dans l’URL du grand-parent <ExtendedOverrides> (au lieu de la chaîne par défaut « upgrade ») ». Pour plus d’informations, consultez Extended Overrides.

<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>

Type de complément : volet Office

Syntaxe

<Requirements>
   ...
</Requirements>

Contenu dans

Peut contenir

L’élément <Requirements> peut contenir les éléments enfants suivants, selon le type de complément.

Élément Contenu Courrier TaskPane
Ensembles Oui Oui Oui
Méthodes Oui Non Oui

Voir aussi

Pour plus d’informations concernant les ensembles de conditions requises, voir Versions d’Office et ensembles de conditions requises.

  • Last updated on