Share via


OverriddenByRibbonApi 要素

リボンにカスタム コンテキスト タブをインストールする API (Office.ribbon.requestCreateControls) をサポートするアプリケーションとプラットフォームの組み合わせで、グループボタン コントロールメニュー コントロール、またはメニュー項目を非表示にするかどうかを指定します。

アドインの種類: 作業ウィンドウ

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

  • Taskpane 1.0

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

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

この要素を省略した場合、既定値は です false。 使用する場合は、親要素の 最初 の子要素である必要があります。

この要素の目的は、カスタム コンテキスト タブをサポートしていないアプリケーションまたはプラットフォームでアドインが実行されているときにカスタム コンテキスト タブを実装するフォールバック エクスペリエンスをアドインに作成することです。 重要な戦略は、カスタム コンテキスト タブからカスタム コア タブ (つまり、 コンテキストに依存しない カスタム タブ) にグループとコントロールの一部またはすべてを複製することです。 次に、カスタム コンテキスト タブがサポートされていないときにこれらのグループとコントロールが表示されるようにしますが、カスタム コンテキスト タブがサポートされている場合は表示されないようにするには、Group>、Control、または menu Item 要素の最初の<子要素としてを追加<OverriddenByRibbonApi>true</OverriddenByRibbonApi>します。<><> その効果は次のとおりです。

  • カスタム コンテキスト タブをサポートするアプリケーションとプラットフォームでアドインが実行されている場合、重複したグループとコントロールはリボンに表示されません。 代わりに、アドインが メソッドを呼び出すと、カスタム コンテキスト タブが requestCreateControls インストールされます。
  • カスタム コンテキスト タブをサポート していない アプリケーションまたはプラットフォームでアドインが実行されている場合、重複したグループとコントロールがリボンに表示されます。

グループのオーバーライド

<ExtensionPoint xsi:type="PrimaryCommandSurface">
  <CustomTab id="Contoso.TabCustom">
    <Group id="Contoso.CustomTab.group1">
      <OverriddenByRibbonApi>true</OverriddenByRibbonApi>
      <Control  xsi:type="Button" id="Contoso.MyButton1">
        <!-- Child elements omitted. -->
      </Control>
    </Group>
    <Label resid="customTabLabel"/>
  </CustomTab>
</ExtensionPoint>

コントロールのオーバーライド

<ExtensionPoint xsi:type="PrimaryCommandSurface">
  <CustomTab id="Contoso.TabCustom">
    <Group id="Contoso.CustomTab.group2">
      <Control  xsi:type="Button" id="Contoso.MyButton2">
        <OverriddenByRibbonApi>true</OverriddenByRibbonApi>
        <!-- Other child elements omitted. -->
      </Control>
    </Group>
    <Label resid="customTabLabel"/>
  </CustomTab>
</ExtensionPoint>

メニュー項目のオーバーライド

<ExtensionPoint xsi:type="PrimaryCommandSurface">
  <CustomTab id="Contoso.TabCustom">
    <Group id="Contoso.CustomTab.group3">
      <Control  xsi:type="Menu" id="Contoso.MyMenu">
        <!-- Other child elements omitted. -->
        <Items>
          <Item id="showGallery">
            <OverriddenByRibbonApi>true</OverriddenByRibbonApi>
            <!-- Other child elements omitted. -->
          </Item>
        </Items>
      </Control>
    </Group>
    <Label resid="customTabLabel"/>
  </CustomTab>
</ExtensionPoint>