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> 内のベース マニフェストから Requirement 要素を繰り返さないでください。 これは効果がなく、<VersionOverrides> 内の <Requirements> 要素の目的について誤解を招く可能性があります。
警告
<VersionOverrides> で <Requirements> 要素を使用する前に細心の注意を払います。要件をサポートしていないプラットフォームとバージョンの組み合わせでは、要件を必要としない機能を呼び出すアドイン コマンドもインストールされないためです。 たとえば、2 つのカスタム リボン ボタンを持つアドインを考えてみましょう。 そのうちの 1 つは、要件セット ExcelApi 1.4 (以降) で使用できる Office JavaScript API を呼び出します。 他の API は、 ExcelApi 1.9 (以降) でのみ使用できる API を呼び出します。
<VersionOverrides で ExcelApi 1.9 の要件を設定した場合> 1.9 がサポートされていない場合、どちらのボタンもリボンに表示されません。 このシナリオでは、「 メソッドと要件セットのサポートのランタイム チェック」で説明されている手法を使用することをお勧めします。 2 番目のボタンによって呼び出されたコードは、最初に isSetSupported を使用して ExcelApi 1.9 のサポートを確認します。 サポートされていない場合、コードは、アドインのこの機能が Office のバージョンでは使用できないことを示すメッセージをユーザーに提供します。
注:
Mail アドインでは、 <VersionOverrides> 1.1 を <VersionOverrides> 1.0 内に入れ子にすることができます。 Office では常に、プラットフォームと Office のバージョンでサポートされている最高バージョン <VersionOverrides> が使用されます。
Override 要素の子として
<Requirements> 要素は、先祖の ExtendedOverrides 要素のコンテキストで Override 要素の子にすることができます。
<Override> 要素は条件付きを表し、"If .." と読み取ることができます。次に ...."陳述。
<Override> 要素が RequirementTokenOverride 型である場合 (つまり、親 Token 要素のxsi:typeがRequirementsToken)、子<Requirements>要素は条件を表し、Value属性が結果になります。 たとえば、次の最初の<Override>は、「現在のプラットフォームで FeatureOne バージョン 1.7 がサポートされている場合は、祖父母の <ExtendedOverrides> (既定の文字列 'upgrade' ではなく) の URL の${token.requirements} トークンの代わりに文字列 'oldAddinVersion' を使用します。"詳細については、「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 のバージョンと要件セット」を参照してください。
Office Add-ins