Requirements 要素

この要素の意味は、基本マニフェストで使用されるか、<VersionOverrides> 要素の子として使用されるか、または Override 要素の子として使用されるかによって異なります。

ヒント

この要素を使用する前に、 Office ホストと API の要件を指定する

基本マニフェスト内

基本マニフェストで使用される場合 (つまり、 OfficeApp の直接の子として)、 <Requirements> 要素は、Office アドインが Office によってアクティブ化される必要がある Office JavaScript API 要件 (要件セット やメソッド) の最小セットを指定します。 指定されたメソッドと要件セットをサポートしていない Office のバージョンとプラットフォーム (Windows、Mac、Web、iOS または iPad など) の組み合わせでは、アドインはアクティブ化されません。

アドインの種類: 作業ウィンドウ、メール

VersionOverrides 要素の子として

VersionOverrides の子として使用する場合、基本マニフェスト設定をオーバーライドする <VersionOverrides> 要素の設定を有効にするために、Office のバージョンとプラットフォーム (Windows、Mac、Web、iOS または iPad など) でサポートする必要がある Office JavaScript API 要件 (要件セットおよび/またはメソッド) の最小セットを指定します。

基本マニフェストで要件 A を指定し、 <VersionOverrides> 内で要件 B を指定するアドインがあるとします。

  • プラットフォームと Office のバージョンが A をサポートしていない場合、アドインはアクティブ化されず、Office はマニフェストの <VersionOverrides> セクションを解析しません。
  • A と B の両方がサポートされている場合は、アドインがアクティブになり、 <VersionOverrides> 内のすべてのマークアップが有効になります。
  • A がサポートされていて B がサポートされていない場合、アドインがアクティブになり、<VersionOverrides> 内のマークアップの一部が有効になります。 具体的には、基本マニフェスト要素をオーバーライドしない <VersionOverrides> の子要素が有効になります。 たとえば、 <WebApplicationInfo> 要素または <EquivalentAddins> が有効になります。 ただし、<Hosts> などの基本マニフェスト要素をオーバーライドする <VersionOverrides> のすべての子要素は有効にはなりません。 代わりに、Office では、上書きされる基本マニフェスト マークアップの値を使用します。

アドインの種類: 作業ウィンドウ、メール

次の VersionOverrides スキーマでのみ有効です:

  • 作業ウィンドウ 1.0
  • メール 1.0
  • メール 1.1

詳細については、「 アドインのみのマニフェストのバージョンのオーバーライド」を参照してください。

次の要件セットに関連付けられています:

  • <VersionOverrides> が Taskpane 1.0 型の場合、AddinCommands 1.1
  • <VersionOverrides> が Mail 1.0 型の場合、Mailbox 1.3
  • <VersionOverrides> が Mail 1.1 型の場合、Mailbox 1.5

注釈

<Requirements> 要素は、基本マニフェストの <Requirements> で指定されていない追加の要件を指定しない場合、<VersionOverrides> では目的を果たしません。 Office のバージョンとプラットフォームが基本マニフェストの要件をサポートしていない場合、アドインはアクティブ化されず、 <VersionOverrides> 要素は解析されません。 このため、<VersionOverrides><Requirements> 要素は、次の両方の条件が満たされている場合にのみ使用してください。

  • アドインには、<VersionOverrides> の構成で実装される追加機能 (アドイン コマンドなど) があり、ベース マニフェストの <Requirements> 要素で指定されていないメソッドまたは要件セットを必要とする追加機能があります。
  • アドインは便利であり、追加機能に必要な要件をサポートしていないプラットフォームと Office バージョンの組み合わせであっても、(追加機能なしで) アクティブ化する必要があります。

ヒント

<VersionOverrides> 内で基本マニフェストの要件要素を繰り返さないでください。 これを行うと効果がなく、<VersionOverrides> 内の <Requirements> 要素の目的に関して誤解を招く可能性があります。

警告

<Requirements> 要素を <>VersionOverrides で使用する前には細心の注意を払ってください。要件をサポートしていないプラットフォームとバージョンの組み合わせでは、その要件を必要としない機能を呼び出すアドイン コマンドであっても、アドイン コマンドはインストールされないからです。 たとえば、2 つのカスタム リボン ボタンがあるアドインがあるとします。 そのうちの 1 つは、要件セット ExcelApi 1.4 (以降) で利用可能な Office JavaScript API を呼び出します。 その他は、 ExcelApi 1.9 (以降) でのみ使用できる API を呼び出します。 <VersionOverrides>ExcelApi 1.9 の要件を設定した場合、1.9 がサポートされていないときは、どちらのボタンもリボンに表示されません。 このシナリオのより良い戦略は、 メソッドと要件セットのサポートのランタイム チェックで説明されている手法を使用することです。 2 番目のボタンによって呼び出されるコードは、最初に isSetSupported を使用して ExcelApi 1.9 のサポートをチェックします。 サポートされていない場合、このコードは、アドインのこの機能がユーザーのバージョンの Office では利用できないことを示すメッセージを表示します。

注:

メール アドインでは、 <VersionOverrides> 1.1 を <VersionOverrides> 1.0 の中に入れ子にすることができます。 Office は常に、プラットフォームと Office のバージョンでサポートされている最上位バージョン <VersionOverrides> を使用します。

Override 要素の子として

<Requirements> 要素は、親祖の ExtendedOverrides 要素のコンテキストにおいて Override 要素の子にすることができます。 <オーバーライド> 要素は条件を表し、"If ...それから...」ステートメント。 <Override> 要素が RequirementTokenOverride 型である (つまり、親 Token 要素のxsi:typeRequirementsToken である) 場合、子要素 <Requirements> 要素は条件を表し、Value 属性は結果となります。 たとえば、以下の最初の <オーバーライド> は、「現在のプラットフォームが FeatureOne バージョン 1.7 をサポートしている場合、祖父母の URL で ${token.requirements} トークンの代わりに文字列 'oldAddinVersion' を使用してください <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>

含まれる場所

含めることができるもの

<Requirements> 要素には、アドインの種類に応じて、次の子要素を含めることができます。

要素 コンテンツ メール TaskPane
Sets はい はい はい
メソッド はい 不要 はい

関連項目

利用できる要件セットの詳細については、「Office のバージョンと要件セット」を参照してください。