Élément OverriddenByRibbonApi

Spécifie si un groupe, un contrôle Bouton, un contrôle Menu ou un élément de menu sera masqué sur les combinaisons d’applications et de plateformes qui prennent en charge l’API (Office.ribbon.requestCreateControls) qui installe des onglets contextuels personnalisés sur le ruban.

Type de complément : volet Office

Valide uniquement dans les schémas VersionOverrides suivants :

  • Volet de tâches 1.0

Pour plus d’informations, consultez Remplacements de version dans le manifeste du complément uniquement.

Associé à ces ensembles de conditions requises :

  • Ruban 1.2 (requis pour Excel, PowerPoint et Word.)

Si cet élément est omis, la valeur par défaut est false. S’il est utilisé, il doit s’agir du premier élément enfant de son élément parent.

L’objectif de cet élément est de créer une expérience de secours dans un complément qui implémente des onglets contextuels personnalisés lorsque le complément s’exécute sur une application ou une plateforme qui ne prend pas en charge les onglets contextuels personnalisés. La stratégie essentielle consiste à dupliquer tout ou partie des groupes et contrôles de votre onglet contextuel personnalisé sur un onglet principal personnalisé (autrement dit, un onglet personnalisé non contextuel). Ensuite, pour vous assurer que ces groupes et contrôles s’affichent lorsque les onglets contextuels personnalisés ne sont pas pris en charge, mais qu’ils n’apparaissent pas lorsque les onglets contextuels personnalisés sont pris en charge, vous ajoutez <OverriddenByRibbonApi>true</OverriddenByRibbonApi> en tant que premier élément enfant des <éléments Group>, <Control> ou Item> de menu<. L’effet de cette opération est le suivant :

  • Si le complément s’exécute sur une application et une plateforme qui prennent en charge des onglets contextuels personnalisés, les groupes et contrôles dupliqués n’apparaissent pas sur le ruban. Au lieu de cela, l’onglet contextuel personnalisé est installé lorsque le complément appelle la requestCreateControls méthode .
  • Si le complément s’exécute sur une application ou une plateforme qui ne prend pas en charge les onglets contextuels personnalisés, les groupes et contrôles dupliqués apparaissent sur le ruban.

Exemples

Substitution d’un groupe

<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>

Substitution d’un contrôle

<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>

Remplacement d’un élément de menu

<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>