Elemento Requirements

  • Artículo

El significado de este elemento depende de si se usa en el manifiesto base, como elemento secundario de un <elemento VersionOverrides> o como elemento secundario del elemento Override.

Sugerencia

Antes de usar este elemento, familiarícese con Especificar hosts y requisitos de API de Office.

En el manifiesto base

Cuando se usa en el manifiesto base (es decir, como elemento secundario directo de OfficeApp), el <elemento Requirements> especifica el conjunto mínimo de requisitos de la API de JavaScript de Office (conjuntos de requisitos o métodos) que Office debe activar el complemento de Office. El complemento no se activará en ninguna combinación de versión y plataforma de Office (como Windows, Mac, web e iOS o iPad) que no admita los métodos y conjuntos de requisitos especificados.

Tipo de complemento: Panel de tareas, Correo

Como elemento secundario de un elemento VersionOverrides

Cuando se usa como elemento secundario de VersionOverrides, especifica el conjunto mínimo de requisitos de la API de JavaScript de Office (conjuntos de requisitos o métodos) que deben ser compatibles con la versión y la plataforma de Office (como Windows, Mac, web e iOS o iPad) para que la configuración del elemento VersionOverrides> que invalida la<configuración del manifiesto base surta efecto.

Considere un complemento que especifica el requisito A en el manifiesto base y especifica el requisito B dentro de VersionOverrides<>.

  • Si la plataforma y la versión de Office no admiten A, el complemento no se activa y Office no analiza la <sección VersionOverrides> del manifiesto.
  • Si se admiten A y B, el complemento se activa y todo el marcado de <VersionOverrides> surte efecto.
  • Si se admite A, pero B no, el complemento se activa y parte del marcado de <VersionOverrides> surte efecto. En concreto, los elementos secundarios de versionOverrides<> que no invalidan los elementos de manifiesto base surten efecto. Por ejemplo, un <elemento WebApplicationInfo> o EquivalentAddins<> surten efecto. Sin embargo, todos los elementos secundarios de VersionOverrides<> que invalidan un elemento de manifiesto base, como <Hosts>, no surten efecto. En su lugar, Office usa los valores del marcado de manifiesto base que, de lo contrario, se habrían invalidado.

Tipo de complemento: Panel de tareas, Correo

Solo es válido en estos esquemas VersionOverrides:

  • Panel de tareas 1.0
  • Correo 1.0
  • Correo 1.1

Para obtener más información, vea Invalidaciones de versión en el manifiesto.

Asociado a estos conjuntos de requisitos:

  • AddinCommands 1.1 cuando el elemento primario <VersionOverrides> es de tipo Panel de tareas 1.0.
  • Buzón 1.3 cuando el elemento primario< VersionOverrides> es de tipo Mail 1.0.
  • Buzón 1.5 cuando el elemento primario< VersionOverrides> es de tipo Mail 1.1.

Comentarios

El <elemento Requirements> no tiene ningún propósito en versionOverrides<> si no especifica ningún requisito adicional que no se especifique en un <elemento Requirements> en el manifiesto base. Si la versión y la plataforma de Office no admiten los requisitos del manifiesto base, el complemento no se activa y el <elemento VersionOverrides> no se analiza. Por este motivo, debe usar un <elemento Requirements> en versionOverrides<> solo cuando se cumplan estas dos condiciones:

  • El complemento tiene características adicionales que se implementan con la configuración en versionOverrides< (como comandos> de complemento) y que requieren un método o conjunto de requisitos que no se especifica en un <elemento Requirements> en el manifiesto base.
  • El complemento es útil y debe activarse (pero sin las características adicionales), incluso en una combinación de plataforma y versión de Office que no admite los requisitos necesarios para las características adicionales.

Sugerencia

No repita los elementos Requirement del manifiesto base dentro de versionOverrides<>. Hacerlo no tiene ningún efecto y es potencialmente engañoso en cuanto al propósito del elemento Requirements> dentro de< un <VersionOverrides>.

Advertencia

Tenga mucho cuidado antes de usar un <elemento Requirements> en versionOverrides<>, ya que en las combinaciones de plataforma y versión que no admiten el requisito, no se instalará ninguno de los comandos del complemento, incluso los que invocan la funcionalidad que no necesita el requisito. Considere, por ejemplo, un complemento que tiene dos botones de cinta personalizados. Una de ellas llama a las API de JavaScript de Office que están disponibles en el conjunto de requisitos ExcelApi 1.4 (y versiones posteriores). El resto llama a las API que solo están disponibles en ExcelApi 1.9 (y versiones posteriores). Si pone un requisito para ExcelApi 1.9 en VersionOverrides<, cuando no se admite 1.9, ninguno de los botones> aparecerá en la cinta de opciones. Una mejor estrategia en este escenario sería usar la técnica descrita en Comprobaciones en tiempo de ejecución para la compatibilidad con el método y el conjunto de requisitos. El código invocado por el segundo botón usa isSetSupported primero para comprobar la compatibilidad con ExcelApi 1.9. Si no se admite, el código proporciona al usuario un mensaje que indica que esta característica del complemento no está disponible en su versión de Office.

Nota:

En los complementos de Correo, es posible que una <versiónOverrides> 1.1 se anida dentro de versionOverrides<> 1.0. Office siempre usará la versión <más alta VersionOverrides> compatible con la plataforma y la versión de Office.

Como elemento secundario del elemento Override

Un <elemento Requirements> puede ser un elemento secundario de un elemento Override en el contexto de un elemento ExtendedOverrides antecesor. Un <elemento Override> expresa un condicional y se puede leer como "If ... a continuación, ..." Declaración. Si el <elemento Override> es de tipo RequirementTokenOverride (lo que significa que el xsi:type de su elemento token primario es RequirementsToken), el elemento Requirements> secundario< expresa la condición y el Value atributo es el consiguiente. Por ejemplo, la primera <invalidación> de lo siguiente se lee "Si la plataforma actual admite featureOne versión 1.7, use la cadena 'oldAddinVersion' en lugar del ${token.requirements} token en la dirección URL del elemento primario< ExtendedOverrides> (en lugar de la cadena predeterminada 'upgrade')." Para obtener más información, consulte 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>

Tipo de complemento: Panel de tareas

Sintaxis

<Requirements>
   ...
</Requirements>

Forma parte de

Puede contener

El <elemento Requirements> puede contener los siguientes elementos secundarios en función del tipo de complemento.

Elemento Contenido Correo TaskPane
Sets Sí Sí Sí
Métodos Yes No Sí

Vea también

Para obtener más información sobre los conjuntos de requisitos, vea Versiones de Office y conjuntos de requisitos.