Elemento OverriddenByRibbonApi

Especifica se umgrupo, controle de botão, controle menu ou item de menu será oculto em combinações de aplicativo e plataforma que dão suporte à API (Office.ribbon.requestCreateControls) que instala guias contextuais personalizadas na faixa de opções.

Tipo de suplemento: Painel de tarefas

Válido somente nestes esquemas VersionOverrides:

• Taskpane 1.0

Para obter mais informações, consulte Substituições de versão no manifesto.

Associado a esses conjuntos de requisitos:

• Faixa de opções 1.2 (necessária para Excel, PowerPoint e Word.)

Se esse elemento for omitido, o padrão será false. Se for usado, ele deve ser o primeiro elemento filho do elemento pai.

Observação

Para obter uma compreensão completa desse elemento, leia Implementar uma experiência alternativa de interface do usuário quando não houver suporte para guias contextuais personalizadas.

A finalidade desse elemento é criar uma experiência de fallback em um suplemento que implementa guias contextuais personalizadas quando o suplemento está em execução em um aplicativo ou plataforma que não dá suporte a guias contextuais personalizadas. A estratégia essencial é que você duplica alguns ou todos os grupos e controles da guia contextual personalizada em uma guia de núcleo personalizada (ou seja, guia personalizada não contratual ). Em seguida, para garantir que esses grupos e controles apareçam quando as guias contextuais personalizadas não têm suporte, mas não aparecem quando há suporte para guias contextuais personalizadas, você adiciona <OverriddenByRibbonApi>true</OverriddenByRibbonApi> como o primeiro elemento filho dos <elementos Group>, <Control> ou menu <Item> . O efeito de fazer isso é o seguinte:

• Se o suplemento for executado em um aplicativo e plataforma que dão suporte a guias contextuais personalizadas, os grupos e controles duplicados não aparecerão na faixa de opções. Em vez disso, a guia contextual personalizada será instalada quando o suplemento chamar o requestCreateControls método.
• Se o suplemento for executado em um aplicativo ou plataforma que não dá suporte a guias contextuais personalizadas, os grupos e controles duplicados serão exibidos na faixa de opções.

Exemplos

Substituindo um grupo

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

Substituindo um controle

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

Substituindo um item 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>