Bloc de construction : Ruban serveur

Article
09/24/2014

Dernière modification : lundi 22 août 2011

S’applique à : SharePoint Foundation 2010

Dans cet article
Modèle objet pour le Ruban serveur
Code XML pour le Ruban serveur
Zones associées au Ruban serveur
Plus d’informations sur le Ruban serveur

Le Ruban serveur de Microsoft SharePoint Foundation crée une interface utilisateur cohérente pour travailler avec les objets SharePoint. Les éléments de plus haut niveau du ruban sont les onglets. Les onglets apparaissent le long de la partie supérieure de la page dans un site . Chaque onglet organise un ensemble de groupes. Ces groupes contiennent un ensemble de contrôles. Chaque groupe peut contenir plusieurs contrôles et un libellé qui lui est propre. Les contrôles du groupe peuvent être des boutons, des menus déroulants, des cases à cocher, des zones de liste déroulante, des boutons partagés et des galeries. Chacun de ces contrôles correspond à une seule commande.

Modèle objet pour le Ruban serveur

Le ruban utilise à la fois le modèle objet ECMAScript (JavaScript, JScript) et le modèle objet serveur.

Objets serveur

IRibbonMenu – Représente l’interface qui est utilisée pour implémenter le ruban.
SPRibbonButton – Représente un bouton à l’intérieur du ruban.
SPRibbonCommand – Représente une commande qui est associée à un contrôle sur le ruban.
SPRibbonMenu – Représente un menu qui est présent sur le ruban.
SPRibbonMenuItem – Représente un contrôle dans un menu sur le ruban.
SPRibbonMenuSection – Représente une section d’un menu du ruban.
SPRibbonPopulateQueryCommand – Représente une commande qui apparaît dans un menu dynamique du ruban à partir de code XML.
SPRibbonQueryCommand – Représente une commande du ruban pour l’événement QueryCommand.

Objets ECMAScript

SP.Ribbon.PageManager
CUI.Page.CommandDispatcher
CUI.Page.PageComponent

Code XML pour le Ruban serveur

Vous pouvez définir et personnaliser le Ruban serveur à l’aide de code XML dans une fonctionnalité ou via une action utilisateur personnalisée. Le code XML qui est utilisé pour le ruban définit chaque onglet, chaque groupe et chaque contrôle. L’élément Tab contient un seul élément Groups. Chaque élément Groups a plusieurs éléments Group. Dans l’élément Group, il y a un seul élément Controls qui contient plusieurs types de contrôles. La liste des types de contrôles disponibles figure dans Architecture du Ruban serveur. Voici un exemple de code XML qui personnalise le ruban.

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="https://schemas.microsoft.com/sharepoint/">
  <CustomAction 
    Id="Ribbon.WikiPageTab.CustomGroupAndControls" 
    Location="CommandUI.Ribbon" 
    RegistrationId="100" 
    RegistrationType="List">
    <CommandUIExtension>
      <CommandUIDefinitions>
        <CommandUIDefinition 
          Location="Ribbon.WikiPageTab.Groups._children">
          <Group 
            Id="Ribbon.WikiPageTab.CustomGroup" 
            Sequence="55" 
            Description="Custom Group" 
            Title="Custom Group" 
            Command="EnableCustomGroup" 
            Template="Ribbon.Templates.Flexible2">
            <Controls Id="Ribbon.WikiPageTab.CustomGroup.Controls">
              <Button
                Id="Ribbon.WikiPageTab.CustomGroup.Controls.CustomButton1" 
                Command="CustomButtonCommand1" 
                Image16by16="/_layouts/images/FILMSTRP.GIF" 
                Image32by32="/_layouts/images/PPEOPLE.GIF" 
                LabelText="" 
                TemplateAlias="o2" 
                Sequence="15" />
            </Controls>
          </Group>
        </CommandUIDefinition>
       </CommandUIDefinitions>
      <CommandUIHandlers>
        <CommandUIHandler Command="EnableCustomGroup" />
        <CommandUIHandler Command="CustomButtonCommand1" CommandAction="javascript:alert('Hello, world!');" />
      </CommandUIHandlers>
    </CommandUIExtension>
  </CustomAction>
</Elements>

Le ruban de SharePoint Foundation peut être personnalisé à l’aide de code XML et ECMAScript (JavaScript, JScript). Le code XML définit les contrôles sur le ruban ; le code JavaScript effectue des actions sur la page ou sur un objet de la page. Vous pouvez utiliser du code JavaScript existant dans le modèle objet JavaScriptSharePoint Foundation ou bien des fonctions JavaScript intégrées. Vous pouvez aussi ajouter votre propre code JavaScript à la page et l’utiliser pour interagir avec le ruban. Pour plus d’informations sur la personnalisation du ruban, voir Personnalisation du ruban serveur.