Elemento de controle do tipo Button

Define um botão que executa uma ação ou inicia um painel de tarefas.

Observação

Este artigo pressupõe familiaridade com o artigo de referência de Controle básico, que contém informações importantes sobre os atributos do elemento.

Um botão executa uma única ação quando o usuário o seleciona. Pode ser a execução de uma função ou a exibição de um painel de tarefas. Cada controle de botão deve ter um valor de id atributo exclusivo entre todos os <elementos Control> no manifesto.

Importante

Os controles do tipo "botão" são ignorados em plataformas móveis. Para dar suporte a plataformas móveis, você também deve ter um controle do tipo "MobileButton" para cada controle do tipo "Button".

Elementos filho

Elemento Obrigatório Descrição
Label Sim O texto do botão.
Supertip Sim A dica detalhada do botão.

Importante: as Supertips só têm suporte em clientes de desktop do Office.
Icon Sim Uma imagem para o botão.
Action Sim Especifica a ação a ser executada. Pode haver apenas um<> filho Action de um <elemento Control>.
Enabled Não Especifica se o controle está habilitado quando o suplemento é iniciado.
OverriddenByRibbonApi Não Especifica se o botão deve aparecer em combinações de aplicativo e plataforma que dão suporte a guias contextuais personalizadas. Se usado, ele deve ser o primeiro elemento filho.

Rótulo

Especifica o texto do botão por meio de seu único atributo, resid, que não pode ter mais de 32 caracteres e deve ser definido como o valor do atributo id de um <elemento String> no <filho ShortStrings> do elemento Resources .

Tipo de suplemento: Painel de tarefas, Email

Válido somente nestes esquemas VersionOverrides:

  • Painel de tarefas 1.0
  • Email 1.0
  • Email 1.1

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

Associado a estes conjuntos de requisitos:

Exemplos

No exemplo a seguir, o botão executa uma função. Ele também está configurado para ser desabilitado quando o suplemento é iniciado. Ele pode ser habilitado programaticamente. Para obter mais informações, consulte Alterar a disponibilidade de comandos de suplemento.

<Control xsi:type="Button" id="Contoso.msgReadFunctionButton">
  <OverriddenByRibbonApi>true</OverriddenByRibbonApi>
  <Label resid="funcReadButtonLabel" />
  <Supertip>
    <Title resid="funcReadSuperTipTitle" />
    <Description resid="funcReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="blue-icon-16" />
    <bt:Image size="32" resid="blue-icon-32" />
    <bt:Image size="80" resid="blue-icon-80" />
  </Icon>
  <Action xsi:type="ExecuteFunction">
    <FunctionName>getSubject</FunctionName>
  </Action>
  <Enabled>false</Enabled>
</Control>

No exemplo a seguir, o botão exibe um painel de tarefas.

<Control xsi:type="Button" id="Contoso.msgReadOpenPaneButton">
  <Label resid="paneReadButtonLabel" />
  <Supertip>
    <Title resid="paneReadSuperTipTitle" />
    <Description resid="paneReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="green-icon-16" />
    <bt:Image size="32" resid="green-icon-32" />
    <bt:Image size="80" resid="green-icon-80" />
  </Icon>
  <Action xsi:type="ShowTaskpane">
    <SourceLocation resid="readTaskPaneUrl" />
  </Action>
</Control>
  • Last updated on