Elemento Button (Server Ribbon)

Artigo
04/08/2023

Aplica-se a: SharePoint 2016 | SharePoint Foundation 2013 | | do SharePoint Online SharePoint Server 2013

Define um controle de botão push.

<Button
     Alt="Text"
     Command="Text"
     CommandType="General | OptionSelect | IgnoredByMenu"
     CommandValueId="Text"
     Description="Text"
     Id="Text"
     Image32by32="Url"
     Image32by32Class="CSS Class Selector"
     Image32by32Left="Negative Integer"
     Image32by32Top="Negative Integer"
     Image16by16="Url"
     Image16by16Class="CSS Class Selector"
     Image16by16Left="Negative Integer"
     Image16by16Top="Negative Integer"
     LabelCss="Text"
     LabelText="Text"
     MenuItemId="Text"
     Sequence="Integer"
     TemplateAlias="Text"
     ToolTipImage32by32="Url"
     ToolTipImage32by32Class="Text"
     ToolTipImage32by32Left="Negative Integer"
     ToolTipImage32by32Top="Negative Integer"
     ToolTipTitle="Text"
     ToolTipDescription="Text"
     ToolTipHelpKeyWord="Text"
     ToolTipShortcutKey="Text"
/>

Elementos e atributos

As seções a seguir descrevem os atributos, os elementos filhos e os elementos pai.

Atributos

Atributo	Descrição
Alt	Opcional. Texto alternativo para o botão.
Comando	Opcional. O nome do comando a ser executado quando o controle for selecionado. Se o controle estiver em um elemento CommandUIDefinition , o valor do atributo Command do controle deverá ser o mesmo que o valor do atributo Command de um elemento CommandUIHandler correspondente.
CommandType	Opcional. Um valor de enumeração que especifica o tipo de comando. Geral. Não é um tipo específico de comando. OptionSelection. Um comando gerado quando um usuário seleciona uma opção em um grupo de opções. IgnoredByMenu. Um comando que é usado para controles que não devem fechar o menu quando selecionado.
CommandValueId	Opcional. Uma cadeia de caracteres enviada com o evento de comando quando o botão é selecionado.
Descrição	Opcional. Uma cadeia de caracteres que descreve o botão. A descrição é exibida somente quando o botão está em um menu e está sendo renderizada com o modo de exibição Menu32 .
Id	Obrigatório. Uma cadeia de caracteres que identifica o controle, como "Ribbon.Library.Share.NewRibbonButton".
Image32by32	Opcional. Uma URL relativa ao servidor a um arquivo que contém uma imagem de 32 por 32 pixels a ser usada como um ícone, como "/_layouts/1033/images/formatmap32x32.png".
Image32by32Class	Opcional. O nome de um seletor de classe CSS a ser aplicado à imagem.
Image32by32Left	Opcional. Um inteiro negativo que representa um deslocamento para a borda esquerda da imagem. Use esse atributo quando o atributo Image32by32 apontar para um arquivo de imagem que contém imagens para muitos ícones. O valor do atributo Image32by32Left é usado para definir o atributo esquerdo CSS para o estilo embutido de uma marca img HTML. Por exemplo, definir o atributo Image32by32Left como "-160" e o atributo Image32by32Top como "-448" resulta em um estilo embutido semelhante ao da seguinte marcação HTML: `HTML<img src="/_layouts/1033/images/formatmap32x32.png" style="position: absolute;left: -160px;top: -448px;" />`
Image32by32Top	Opcional. Um inteiro negativo que representa um deslocamento para a borda superior da imagem. Use esse atributo quando o atributo Image32by32 apontar para um arquivo de imagem que contém as imagens para muitos ícones. O valor do atributo Image32by32Top é usado para definir o atributo superior do CSS para o estilo embutido de uma marca img HTML.
Imagem16by16	Opcional. Uma URL relativa ao servidor a um arquivo que contém uma imagem de 16 por 16 pixels a ser usada como um ícone, como "/_layouts/1033/images/formatmap16x16.png".
Image16by16Class	Opcional. O nome de um seletor de classe CSS a ser aplicado à imagem.
Image16by16Left	Opcional. Um inteiro negativo que representa um deslocamento para a borda esquerda da imagem. Use esse atributo quando o atributo Image16by16 apontar para um arquivo de imagem que contém imagens para muitos ícones. O valor do atributo Image16by16Left é usado para definir o atributo esquerdo CSS para o estilo embutido de uma marca img HTML.
Image16by16Top	Opcional. Um inteiro negativo que representa um deslocamento para a borda superior da imagem. Use esse atributo quando o atributo Image16by16 apontar para um arquivo de imagem que contém imagens para muitos ícones. O valor do atributo Image16by16Top é usado para definir o atributo superior do CSS para o estilo embutido de uma marca img HTML.
LabelCss	Opcional. O nome de um seletor de classe CSS a ser aplicado ao rótulo do controle.
Labeltext	Opcional. O texto para rotular o controle.
MenuItemId	Opcional. Uma cadeia de caracteres que identifica o item de menu em que o botão está localizado.
Sequence	Opcional. Um inteiro que especifica a ordem de posicionamento entre nós XML irmãos.
TemplateAlias	Opcional. Uma cadeia de caracteres que corresponde ao valor do atributo TemplateAlias para um elemento ControlRef , um elemento OverflowArea ou um elemento OverflowSection em um elemento GroupTemplate . O atributo TemplateAlias é usado para controles de tamanho e posição em um grupo quando um modelo é aplicado ao grupo.
ToolTipImage32by32	Opcional. Uma URL relativa ao servidor a um arquivo que contém uma imagem de 32 por 32 pixels a ser usada na dica de ferramenta, como "/_layouts/1033/images/formatmap32x32.png".
ToolTipImage32by32Class	Opcional. O nome de um seletor de classe CSS a ser aplicado à imagem.
ToolTipImage32by32Left	Opcional. Um inteiro negativo que representa um deslocamento para a borda esquerda da imagem. Use esse atributo quando o atributo ToolTipImage32by32 apontar para um arquivo de imagem que contém as imagens para muitos ícones. O valor do atributo ToolTipImage32by32Left é usado para definir o atributo esquerdo CSS quando a página é criada.
ToolTipImage32by32Top	Opcional. Um inteiro negativo que representa um deslocamento para a borda superior da imagem. Use esse atributo quando o atributo ToolTipImage32by32 apontar para um arquivo de imagem que contém as imagens para muitos ícones. O valor do atributo ToolTipImage32by32Top é usado para definir o atributo superior do CSS quando a página é criada.
Tooltiptitle	Opcional. O texto que aparece como o título da dica de ferramenta.
ToolTipDescription	Opcional. O texto que aparece no corpo da dica de ferramenta.
ToolTipHelpKeyWord	Opcional. A palavra-chave usada pela Ajuda sensível ao contexto.
ToolTipShortcutKey	Opcional. O texto a ser exibido para a chave de atalho na dica de ferramenta. Por exemplo, se a chave de atalho para o controle for Alt+J, o valor desse atributo será "Alt+J". A dica de ferramenta exibirá o texto da chave de atalho em parênteses após o título da dica de ferramenta: "(Alt+J)".

Elementos filho

Nenhum

Elementos pai

CommandUIDefinition
Controles (Grupo)
Controles (MenuSection)

Occurrences

Mínimo: 0
Máximo: desvinculado

Exemplo

O exemplo a seguir mostra como adicionar um controle de botão à faixa de opções do servidor. O exemplo adiciona um botão Ajuda à faixa de opções no mesmo grupo que os controles Novo Documento, Nova Pasta e Carregar Documento internos:

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
  <CustomAction
    Id="NewUIRibbonControl"
    RegistrationType="List"
    RegistrationId="101"
    Location="CommandUI.Ribbon">
    <CommandUIExtension>
      <CommandUIDefinitions>
        <CommandUIDefinition
           Location="Ribbon.Documents.New.Controls._children">
          <Button
             Id="NewUIRibbonControl.ShowHelp"
             Alt="Help"
             Sequence="1981"
             Command="ShowHelp"
             Image32by32="/_layouts/images/newui/dochelp.png"
             LabelText="Help"
             TemplateAlias="o1"/>
        </CommandUIDefinition>
      </CommandUIDefinitions>
      <CommandUIHandlers>
        <CommandUIHandler
         Command="ShowHelp"
         CommandAction="javascript:window.open('https://msdn.microsoft.com/library/ee539395%28office.14%29.aspx');" />
      </CommandUIHandlers>
    </CommandUIExtension>
  </CustomAction>
</Elements>

Confira também

Passo a passo: adicionando um botão à faixa de opções do servidor

Partilhar via