Button, élément

Article
09/24/2014

Dernière modification : mardi 15 novembre 2011

S’applique à : SharePoint Foundation 2010

Dans cet article
Attributs
Éléments enfants
Éléments parents
Occurrences

Définit un contrôle de bouton de commande.

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

Attributs

Attribut	Description
Alt	Facultatif. Texte de remplacement du bouton.
Command	Facultatif. Nom de la commande à exécuter lorsque l’utilisateur clique sur le contrôle. Si le contrôle se trouve dans un élément CommandUIDefinition, la valeur de l’attribut Command du contrôle doit être identique à la valeur de l’attribut Command d’un élément CommandUIHandler correspondant.
CommandType	Facultatif. Valeur d’énumération qui spécifie le type de commande. General. Type de commande non spécifique. OptionSelection. Commande générée lorsqu’un utilisateur sélectionne une option dans un groupe d’options. IgnoredByMenu. Commande utilisée pour les contrôles qui ne doivent pas fermer le menu lorsque l’utilisateur clique sur ces contrôles.
CommandValueId	Facultatif. Chaîne envoyée avec l’événement de commande lorsque l’utilisateur clique sur le bouton.
Description	Facultatif. Chaîne qui décrit le bouton. La description apparaît uniquement lorsque le bouton se trouve dans un menu et qu’il apparaît dans le mode d’affichage Menu32.
Id	Obligatoire. Chaîne qui identifie le contrôle, telle que « Ribbon.Library.Share.NewRibbonButton ».
Image32by32	Facultatif. URL relative de serveur vers un fichier qui contient une image de 32 pixels de côté à utiliser comme icône, telle que « /_layouts/1033/images/formatmap32x32.png ».
Image32by32Class	Facultatif. Nom d’un sélecteur de classe CSS à appliquer à l’image.
Image32by32Left	Facultatif. Entier négatif qui représente un décalage pour le bord gauche de l’image. Utilisez cet attribut lorsque l’attribut Image32by32 pointe vers un fichier image qui contient des images de nombreuses icônes. La valeur de l’attribut Image32by32Left permet de définir l’attribut left CSS pour le style intraligne d’une balise img HTML. Par exemple, la définition de l’attribut Image32by32Left sur « -160 » et de l’attribut Image32by32Top sur « -448 » aboutit à un style intraligne similaire à celui indiqué dans le marquage HTML suivant : `<img src="/_layouts/1033/images/formatmap32x32.png" style="position: absolute;left: -160px;top: -448px;" />`
Image32by32Top	Facultatif. Entier négatif qui représente un décalage pour le bord supérieur de l’image. Utilisez cet attribut lorsque l’attribut Image32by32 pointe vers un fichier image qui contient les images de nombreuses icônes. La valeur de l’attribut Image32by32Top permet de définir l’attribut CSS top pour le style intraligne d’une balise HTML img.
Image16by16	Facultatif. URL relative de serveur vers un fichier qui contient une image de 16 pixels de côté à utiliser comme icône, telle que « /_layouts/1033/images/formatmap16x16.png ».
Image16by16Class	Facultatif. Nom d’un sélecteur de classe CSS à appliquer à l’image.
Image16by16Left	Facultatif. Entier négatif qui représente un décalage pour le bord gauche de l’image. Utilisez cet attribut lorsque l’attribut Image16by16 pointe vers un fichier image qui contient des images de nombreuses icônes. La valeur de l’attribut Image16by16Left permet de définir l’attribut CSS left pour le style intraligne d’une balise HTML img.
Image16by16Top	Facultatif. Entier négatif qui représente un décalage pour le bord supérieur de l’image. Utilisez cet attribut lorsque l’attribut Image16by16 pointe vers un fichier image qui contient des images de nombreuses icônes. La valeur de l’attribut Image16by16Top permet de définir l’attribut CSS top pour le style intraligne d’une balise HTML img.
LabelCss	Facultatif. Nom d’un sélecteur de classe CSS à appliquer à l’étiquette du contrôle.
LabelText	Facultatif. Texte de l’étiquette du contrôle.
MenuItemId	Facultatif. Chaîne qui identifie l’élément de menu où se trouve le bouton.
Sequence	Facultatif. Entier qui spécifie l’ordre d’emplacement dans les nœuds XML frères.
TemplateAlias	Facultatif. Chaîne qui correspond à la valeur de l’attribut TemplateAlias pour un élément ControlRef, un élément OverflowArea ou un élément OverflowSection dans un élément GroupTemplate. L’attribut TemplateAlias permet de dimensionner et de positionner les contrôles dans un groupe lorsqu’un modèle est appliqué au groupe.
ToolTipImage32by32	Facultatif. URL relative de serveur vers un fichier qui contient une image de 32 pixels de côté à utiliser dans l’info-bulle, telle que « /_layouts/1033/images/formatmap32x32.png ».
ToolTipImage32by32Class	Facultatif. Nom d’un sélecteur de classe CSS à appliquer à l’image.
ToolTipImage32by32Left	Facultatif. Entier négatif qui représente un décalage pour le bord gauche de l’image. Utilisez cet attribut lorsque l’attribut ToolTipImage32by32 pointe vers un fichier image qui contient les images de nombreuses icônes. La valeur de l’attribut ToolTipImage32by32Left permet de définir l’attribut CSS left lorsque la page est créée.
ToolTipImage32by32Top	Facultatif. Entier négatif qui représente un décalage pour le bord supérieur de l’image. Utilisez cet attribut lorsque l’attribut ToolTipImage32by32 pointe vers un fichier image qui contient les images de nombreuses icônes. La valeur de l’attribut ToolTipImage32by32Top permet de définir l’attribut CSS top lorsque la page est créée.
ToolTipTitle	Facultatif. Texte qui apparaît comme titre de l’info-bulle.
ToolTipDescription	Facultatif. Texte qui apparaît dans le corps de l’info-bulle.
ToolTipHelpKeyWord	Facultatif. Mot clé utilisé par l’aide contextuelle.
ToolTipShortcutKey	Facultatif. Texte à afficher pour la touche de raccourci dans l’info-bulle. Par exemple, si la touche de raccourci pour le contrôle est ALT + J, la valeur de cet attribut est « ALT + J ». L’info-bulle affiche le texte de la touche de raccourci entre parenthèses après le titre de l’info-bulle « (ALT + J) ».

Éléments enfants

Aucun

Éléments parents

CommandUIDefinition

Controls (Group)

Controls (MenuSection)

Occurrences

Minimum : 0

Maximum : pas de limite

Exemple

L’exemple suivant montre comment ajouter un contrôle de bouton au Ruban serveur. L’exemple ajoute un bouton « Help » au Ruban dans le même groupe que les contrôles Nouveau Document, Nouveau dossier et Télécharger un document intégrés :

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="https://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/en-us/library/ee539395%28office.14%29.aspx');" />
      </CommandUIHandlers>
    </CommandUIExtension>
  </CustomAction>
</Elements>

Voir aussi

Tâches

Procédure pas à pas : ajout d’un bouton au Ruban serveur