Elemento Button (cinta de opciones del servidor)

2023-04-08

Se aplica a: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Define un control de botón de comando.

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

En las siguientes secciones se describen los atributos, elementos secundarios y elementos primarios.

Atributos

Atributo	Descripción
Alt	Opcional. Texto alternativo para el botón.
Command	Opcional. Nombre del comando que se va a ejecutar cuando se selecciona el control. Si el control está en un elemento CommandUIDefinition, el valor del atributo Command del control debe ser el mismo que el valor del atributo Command de un elemento CommandUIHandler correspondiente.
CommandType	Opcional. Valor de enumeración que especifica el tipo de comando. General. No es un tipo de comando específico. OptionSelection. Comando que se genera cuando un usuario selecciona una opción en un grupo de opciones. IgnoreByMenu. Comando que se usa para los controles que no deben cerrar el menú cuando se selecciona.
CommandValueId	Opcional. Cadena que se envía con el evento de comando cuando se selecciona el botón.
Descripción	Opcional. Cadena que describe el botón. La descripción se muestra únicamente cuando el botón se encuentra en un menú y se representa con el modo de presentación Menu32.
Id	Necesario. Cadena que identifica el control, como “Ribbon.Library.Share.NewRibbonButton”.
Imagen32by32	Opcional. Dirección URL relativa al servidor a un archivo que contiene una imagen de 32 por 32 píxeles que se usará como icono, como "/_layouts/1033/images/formatmap32x32.png".
Image32by32Class	Opcional. Nombre de un selector de clases CSS que se aplicará a la imagen.
Image32by32Left	Opcional. Entero negativo que representa un desplazamiento del borde izquierdo de la imagen. Use este atributo cuando el atributo Image32by32 señale a un archivo de imagen que contenga imágenes de varios iconos. El valor del atributo Image32by32Left se usa para establecer el atributo left de CSS para el estilo en línea de una etiqueta HTML img. Por ejemplo, establecer el atributo Image32by32Left en "-160" y el atributo Image32by32Top en "-448" da como resultado un estilo alineado similar al del marcado HTML siguiente: `HTML<img src="/_layouts/1033/images/formatmap32x32.png" style="position: absolute;left: -160px;top: -448px;" />`
Image32by32Top	Opcional. Entero negativo que representa un desplazamiento del borde superior de la imagen. Use este atributo cuando el atributo Image32by32 señale a un archivo de imagen que contenga las imágenes de varios iconos. El valor del atributo Image32by32Top se usa para establecer el atributo top de CSS para el estilo en línea de una etiqueta HTML img.
Imagen16by16	Opcional. Dirección URL relativa al servidor a un archivo que contiene una imagen de 16 por 16 píxeles que se usará como icono, como "/_layouts/1033/images/formatmap16x16.png".
Image16by16Class	Opcional. Nombre de un selector de clases CSS que se aplicará a la imagen.
Imagen16by16Left	Opcional. Entero negativo que representa un desplazamiento del borde izquierdo de la imagen. Use este atributo cuando el atributo Image16by16 señale a un archivo de imagen que contenga imágenes de varios iconos. El valor del atributo Image16by16Left se usa para establecer el atributo left de CSS para el estilo en línea de una etiqueta HTML img.
Image16by16Top	Opcional. Entero negativo que representa un desplazamiento del borde superior de la imagen. Use este atributo cuando el atributo Image16by16 señale a un archivo de imagen que contenga imágenes de varios iconos. El valor del atributo Image16by16Top se usa para establecer el atributo top de CSS para el estilo en línea de una etiqueta HTML img.
LabelCss	Opcional. El nombre de un selector de clases CSS que se aplicará a la etiqueta del control.
LabelText	Opcional. El texto para etiquetar el control.
MenuItemId	Opcional. Cadena que identifica el elemento de menú en el que se ubica el botón.
Sequence	Opcional. Entero que especifica el orden de colocación entre nodos XML del mismo nivel.
TemplateAlias	Opcional. Cadena que coincide con el valor del atributo TemplateAlias de un elemento ControlRef, un elemento OverflowArea o un elemento OverflowSection en un elemento GroupTemplate. El atributo TemplateAlias se usa para cambiar el tamaño de los controles y posicionarlos dentro de un grupo cuando se aplica una plantilla al grupo.
ToolTipImage32by32	Opcional. Dirección URL relativa al servidor a un archivo que contiene una imagen de 32 por 32 píxeles que se usará en la información sobre herramientas, como "/_layouts/1033/images/formatmap32x32.png".
ToolTipImage32by32Class	Opcional. Nombre de un selector de clases CSS que se aplicará a la imagen.
ToolTipImage32by32Left	Opcional. Entero negativo que representa un desplazamiento del borde izquierdo de la imagen. Use este atributo cuando el atributo ToolTipImage32by32 señale a un archivo de imagen que contenga las imágenes de varios iconos. El valor del atributo ToolTipImage32by32Left se usa para establecer el atributo left de CSS cuando se crea la página.
ToolTipImage32by32Top	Opcional. Entero negativo que representa un desplazamiento del borde superior de la imagen. Use este atributo cuando el atributo ToolTipImage32by32 señale a un archivo de imagen que contenga las imágenes de varios iconos. El valor del atributo ToolTipImage32by32Top se usa para establecer el atributo top de CSS cuando se crea la página.
ToolTipTitle	Opcional. Texto que aparece como título de la información sobre herramientas.
ToolTipDescription	Opcional. Texto que aparece en el cuerpo de la información sobre herramientas.
ToolTipHelpKeyWord	Opcional. Palabra clave que se usa en la ayuda contextual.
ToolTipShortcutKey	Opcional. El texto para mostrar en la tecla de método abreviado de la información sobre herramientas. Por ejemplo, si la tecla de método abreviado del control es Alt+J, el valor de este atributo es "Alt+J". La información sobre herramientas mostrará el texto de la tecla de método abreviado entre paréntesis después del título de la información sobre herramientas: "(Alt+J)".

Elementos secundarios

Ninguno

Elementos principales

CommandUIDefinition
Controls (Group)
Controls (MenuSection)

Repeticiones

Mínimo: 0
Máximo: sin límite

Ejemplo

En el ejemplo siguiente se muestra cómo agregar un control de botón a la cinta de opciones del servidor. En el ejemplo se agrega un botón ayuda a la cinta de opciones del mismo grupo que los controles integrados Nuevo documento, Nueva carpeta y Cargar documento :

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

Vea también

Tutorial: Agregar un botón a la cinta de opciones del servidor

Compartir a través de