Elemento Requirements

Artigo
10/23/2024

O significado deste elemento depende se é utilizado no manifesto base, como subordinado de um <elemento VersionOverrides> ou como subordinado do elemento Substituição.

Dica

Antes de utilizar este elemento, familiarize-se com Especificar os anfitriões do Office e os requisitos da API

No manifesto base

Quando utilizado no manifesto base (ou seja, como um subordinado direto do OfficeApp), o <elemento Requisitos> especifica o conjunto mínimo de requisitos da API JavaScript do Office (conjuntos de requisitos e/ou métodos) que o seu Suplemento do Office precisa de ativar pelo Office. O suplemento não será ativado em nenhuma combinação de versão e plataforma do Office (como Windows, Mac, Web e iOS ou iPad) que não suporte os métodos e conjuntos de requisitos especificados.

Tipo de suplemento: Painel de tarefas, Correio

Como elemento subordinado de um elemento VersionOverrides

Quando utilizado como subordinado de VersionOverrides, especifica o conjunto mínimo de requisitos da API JavaScript do Office (conjuntos de requisitos e/ou métodos) que têm de ser suportados pela versão e plataforma do Office (como Windows, Mac, Web e iOS ou iPad) para que as definições no elemento VersionOverrides> que substituam as definições do manifesto base entrem em< vigor.

Considere um suplemento que especifica o requisito A no manifesto base e especifica o requisito B dentro de <VersionOverrides>.

Se a plataforma e a versão do Office não suportarem A, o suplemento não está ativado e o Office não analisa a <secção VersionOverrides> do manifesto.
Se A e B forem suportados, o suplemento será ativado e todas as marcações nas VersionOverrides> entrarão em< vigor.
Se A for suportado, mas B não for, o suplemento será ativado e algumas das marcações nas VersionOverrides> entrarão em< vigor. Especificamente, os elementos subordinados das <VersionOverrides> que não substituem os elementos do manifesto base têm efeito. Por exemplo, um <elemento WebApplicationInfo> ou um <EquivalentAddins> tem efeito. No entanto, todos os elementos subordinados do <VersionOverrides> que substituem um elemento de manifesto base, como <Anfitriões>, não têm efeito. Em vez disso, o Office utiliza os valores da marcação do manifesto base que, de outra forma, teria sido substituída.

Tipo de suplemento: Painel de tarefas, Correio

Válido apenas nestes esquemas VersionOverrides:

Painel de tarefas 1.0
Email 1.0
Email 1.1

Para obter mais informações, veja Substituições de versões no manifesto apenas do suplemento.

Associados a estes conjuntos de requisitos:

AddinCommands 1.1 quando versionOverrides principal< é o> tipo Taskpane 1.0.
Caixa de correio 1.3 quando o VersionOverrides> principal< é do tipo Correio 1.0.
Caixa de correio 1.5 quando o VersionOverrides> principal< é do tipo Correio 1.1.

Comentários

O <elemento Requisitos> não tem qualquer finalidade numa <VersionOverrides> se não especificar requisitos adicionais que não estejam especificados num< Requisitos> no manifesto base. Se a versão e a plataforma do Office não suportarem os requisitos no manifesto base, o suplemento não é ativado e o <elemento VersionOverrides> não é analisado. Por este motivo, deve utilizar um <elemento Requisitos> num <VersionOverrides apenas quando ambas as condições forem cumpridas> :

O suplemento tem funcionalidades adicionais que são implementadas com a configuração num <VersionOverrides (como Comandos> de Suplemento) e que requerem um método ou conjunto de requisitos que não está especificado num <elemento Requisitos> no manifesto base.
O seu suplemento é útil e deve ser ativado (mas sem as funcionalidades adicionais), mesmo numa combinação de plataforma e versão do Office que não suporta os requisitos necessários para as funcionalidades adicionais.

Dica

Não repita Os elementos requisitos do manifesto base dentro de um <VersionOverrides>. Fazê-lo não tem qualquer efeito e é potencialmente enganador quanto à finalidade do <elemento Requisitos> dentro de uma <VersionOverrides>.

Aviso

Utilize muito cuidado antes de utilizar um <elemento Requisitos> num <VersionOverrides>, uma vez que nas combinações de plataformas e versões que não suportam o requisito, nenhum dos comandos de suplemento será instalado, mesmo aqueles que invocam funcionalidades que não precisam do requisito. Considere, por exemplo, um suplemento com dois botões de friso personalizados. Uma delas chama as APIs JavaScript do Office que estão disponíveis no conjunto de requisitos ExcelApi 1.4 (e posterior). As outras chamadas são APIs que só estão disponíveis no ExcelApi 1.9 (e posterior). Se colocar um requisito para o <ExcelApi 1.9 nas VersionOverrides, quando a versão 1.9 não for suportada, nenhum dos botões aparecerá no friso>. Uma estratégia melhor neste cenário seria utilizar a técnica descrita em Verificações de runtime para o método e suporte do conjunto de requisitos. O código invocado pelo segundo botão utiliza isSetSupported primeiro para verificar o suporte do ExcelApi 1.9. Se não for suportado, o código dá ao utilizador uma mensagem a indicar que esta funcionalidade do suplemento não está disponível na respetiva versão do Office.

Observação

Em Suplementos de correio, é possível aninhar um <VersionOverrides> 1.1 numa <VersionOverrides> 1.0. O Office utilizará sempre a versão <mais alta VersionOverrides> que é suportada pela plataforma e pela versão do Office.

Como elemento subordinado do elemento Substituir

Um <elemento Requisitos> pode ser subordinado de um elemento Substituição no contexto de um elemento predecessor ExtendedOverrides . Um <elemento Substituir> expressa uma condição e pode ser lido como um "Se... e, em seguida, ..." instrução. Se o <elemento Substituição> for do tipo RequirementTokenOverride (o que significa que o xsi:type elemento do token principal é RequirementsToken), o elemento Requisitos> subordinados< expressa a condição e o Value atributo é o consequente. Por exemplo, a primeira <Substituição> no seguinte é lida "Se a plataforma atual suportar a versão 1.7 da FeatureOne, utilize a cadeia "oldAddinVersion" em vez do ${token.requirements} token no URL das Extensões> Do avô< (em vez da cadeia predefinida 'upgrade')." Para obter mais informações, 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 suplemento: Painel de tarefas

Sintaxe

<Requirements>
   ...
</Requirements>

Contido em

Pode conter

O <elemento Requisitos> pode conter os seguintes elementos subordinados consoante o tipo de suplemento.

Elemento	Conteúdo	Email	TaskPane
Sets	Sim	Sim	Sim
Métodos	Sim	Não	Sim

Confira também

Para saber mais sobre os conjuntos de requisitos, confira Versões do Office e conjuntos de requisitos.

Compartilhar via