Partilhar via

Control element of type Button

  • Artigo

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

Observação

Este artigo pressupõe estar familiarizado com o artigo de referência de Controlo 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 controlo de botão tem de ter um id valor de atributo exclusivo entre todos os <elementos de Controlo> no manifesto.

Importante

Os controlos de tipo "Botão" são ignorados nas plataformas móveis. Para suportar plataformas móveis, também tem de ter um controlo do tipo "MobileButton" para cada controlo do tipo "Botão".

Elementos filho

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

Importante: as superscrições só são suportadas em clientes de ambiente de trabalho do Office.
Icon Sim Uma imagem para o botão.
Action Sim Especifica a ação a ser executada. Só pode existir um <elemento Subordinado de ação> de um <elemento Controlo> .
Enabled Não Especifica se o controlo está ativado quando o suplemento é iniciado.
OverriddenByRibbonApi Não Especifica se o botão deve aparecer nas combinações de aplicações e plataformas que suportam separadores contextuais personalizados. Se utilizado, tem de ser o primeiro elemento subordinado.

Rótulo

Especifica o texto para o botão através do seu único atributo, residir, que não pode ter mais de 32 carateres e tem de ser definido para o valor do atributo id de um <elemento String> no <subordinado ShortStrings> do elemento Resources .

Tipo de suplemento: Painel de tarefas, Correio

Válido apenas nestes esquemas VersionOverrides:

  • Painel de tarefas 1.0
  • Email 1.0
  • Email 1.1

Para obter mais informações, veja Substituições de versões no manifesto apenas do suplemento.

Associados a estes conjuntos de requisitos:

Exemplos

No exemplo seguinte, o botão executa uma função. Também está configurado para ser desativado quando o suplemento é iniciado. Pode ser ativado programaticamente. Para obter mais informações, consulte Ativar e Desativar 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 seguinte, o botão apresenta 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>