XML du ruban

L’élément Ruban (XML) vous permet de personnaliser un ruban à l’aide de XML. Utilisez l’élément Ruban (XML) si vous souhaitez personnaliser le ruban d’une manière qui n’est pas prise en charge par l’élément Ruban (Concepteur visuel). Pour obtenir une comparaison de ce que vous pouvez faire avec chaque élément, consultez la vue d’ensemble du ruban.

S’applique à : Les informations contenues dans cette rubrique s’appliquent aux projets de niveau document et aux projets de complément VSTO pour les applications suivantes : Excel ; InfoPath 2013 et InfoPath 2010 ; Perspective; PowerPoint ; Projet; Visio ; Mot. Pour plus d’informations, consultez Fonctionnalités disponibles par type d’application et de projet Office.

Ajouter un élément de ruban (XML) à un projet

Vous pouvez ajouter un élément de ruban (XML) à n’importe quel projet Office à partir de la boîte de dialogue Ajouter un nouvel élément . Visual Studio ajoute automatiquement les fichiers suivants à votre projet :

• Fichier XML du ruban. Ce fichier définit l’interface utilisateur du ruban. Utilisez ce fichier pour ajouter des éléments d’interface utilisateur tels que des onglets, des groupes et des contrôles. Pour plus d’informations, consultez la référence de fichier XML du ruban plus loin dans cette rubrique.

• Fichier de code du ruban. Ce fichier contient la classe Ribbon. Cette classe a le nom que vous avez spécifié pour l’élément Ruban (XML) dans la boîte de dialogue Ajouter un nouvel élément . Les applications Microsoft Office utilisent une instance de cette classe pour charger le ruban personnalisé. Pour plus d’informations, consultez la référence de classe du ruban plus loin dans cette rubrique.

  Par défaut, ces fichiers ajoutent un groupe personnalisé à l’onglet Compléments du ruban.

Afficher le ruban personnalisé dans une application Microsoft Office

Après avoir ajouté un élément Ribbon (XML) à votre projet, vous devez ajouter du code à la classe ThisAddin, ThisWorkbook ou ThisDocument qui remplace la CreateRibbonExtensibilityObject méthode et retourne la classe XML du ruban à l’application Office.

L’exemple de code suivant remplace la CreateRibbonExtensibilityObject méthode et retourne une classe XML du ruban nommée MyRibbon.

protected override Microsoft.Office.Core.IRibbonExtensibility CreateRibbonExtensibilityObject()
{
    return new MyRibbon();
}

Protected Overrides Function CreateRibbonExtensibilityObject() As  _
Microsoft.Office.Core.IRibbonExtensibility
    Return New MyRibbon()
End Function

Définir le comportement du ruban personnalisé

Vous pouvez répondre aux actions utilisateur, telles que cliquer sur un bouton sur le ruban, en créant des méthodes de rappel. Les méthodes de rappel ressemblent à des événements dans les contrôles Windows Forms, mais elles sont identifiées par un attribut dans le xml de l’élément d’interface utilisateur. Vous écrivez des méthodes dans la classe Ribbon et un contrôle appelle la méthode portant le même nom que la valeur d’attribut. Par exemple, vous pouvez créer une méthode de rappel appelée lorsqu’un utilisateur clique sur un bouton sur le ruban. Deux étapes sont nécessaires pour créer une méthode de rappel :

• Attribuez un attribut à un contrôle dans le fichier XML du ruban qui identifie une méthode de rappel dans votre code.

• Définissez la méthode de rappel dans la classe Ribbon.

Pour obtenir une procédure pas à pas qui montre comment automatiser une application à partir du ruban, consultez Procédure pas à pas : Créer un onglet personnalisé à l’aide du code XML du ruban.

Affecter des méthodes de rappel aux contrôles

Pour affecter une méthode de rappel à un contrôle dans le fichier XML du ruban, ajoutez un attribut qui spécifie le type de la méthode de rappel et le nom de la méthode. Par exemple, l’élément suivant définit un bouton bascule qui a une méthode de rappel onAction nommée OnToggleButton1.

<toggleButton id="toggleButton1" onAction="OnToggleButton1" />

onAction est appelé lorsque l’utilisateur effectue la tâche principale associée à un contrôle particulier. Par exemple, la méthode de rappel onAction d’un bouton bascule est appelée lorsque l’utilisateur clique sur le bouton.

La méthode que vous spécifiez dans l’attribut peut avoir n’importe quel nom. Toutefois, il doit correspondre au nom de la méthode que vous définissez dans le fichier de code du ruban.

Il existe de nombreux types de méthodes de rappel que vous pouvez affecter aux contrôles du ruban. Pour obtenir la liste complète des méthodes de rappel disponibles pour chaque contrôle, consultez l’article technique Personnaliser l’interface utilisateur du ruban Office (2007) pour les développeurs (partie 3 sur 3).

Définir des méthodes de rappel

Définissez vos méthodes de rappel dans la classe Ruban dans le fichier de code du ruban. Une méthode de rappel a plusieurs exigences :

• Elle doit être déclarée publique.

• Son nom doit correspondre au nom d’une méthode de rappel que vous avez affectée à un contrôle dans le fichier XML du ruban.

• Sa signature doit correspondre à la signature d’un type de méthode de rappel disponible pour le contrôle Ruban associé.

  Pour obtenir la liste complète des signatures de méthode de rappel pour les contrôles du ruban, consultez l’article technique Personnaliser l’interface utilisateur du ruban Office (2007) pour les développeurs (partie 3 sur 3). Visual Studio ne prend pas en charge IntelliSense pour les méthodes de rappel que vous créez dans le fichier de code du ruban. Si vous créez une méthode de rappel qui ne correspond pas à une signature valide, le code est compilé, mais rien ne se produit lorsque l’utilisateur clique sur le contrôle.

  Toutes les méthodes de rappel ont un IRibbonControl paramètre qui représente le contrôle qui a appelé la méthode. Vous pouvez utiliser ce paramètre pour réutiliser la même méthode de rappel pour plusieurs contrôles. L’exemple de code suivant illustre une méthode de rappel onAction qui effectue différentes tâches en fonction des clics de l’utilisateur.

  • C#
  • VB

  public void OnActionCallback(Office.IRibbonControl control, bool isPressed)
  {
      if (control.Id == "checkBox1")
      {
          MessageBox.Show("You clicked " + control.Id);
      }
      else
      {
          MessageBox.Show("You clicked a different control.");
      }
  }
  

Référence de fichier XML du ruban

Vous pouvez définir votre ruban personnalisé en ajoutant des éléments et des attributs au fichier XML du ruban. Par défaut, le fichier XML du ruban contient le code XML suivant.

<?xml version="1.0" encoding="UTF-8"?>
<customUI xmlns="http://schemas.microsoft.com/office/2006/01/customui" onLoad="OnLoad">
  <ribbon>
    <tabs>
      <tab idMso="TabAddIns">
        <group id="MyGroup"
               label="My Group">
        </group>
      </tab>
    </tabs>
  </ribbon>
</customUI>

Le tableau suivant décrit les éléments par défaut dans le fichier XML du ruban.

Ces éléments ont des attributs qui spécifient l’apparence et le comportement du ruban personnalisé. Le tableau suivant décrit les attributs par défaut dans le fichier XML du ruban.

Les éléments et attributs par défaut dans le fichier XML du ruban sont un petit sous-ensemble des éléments et attributs disponibles. Pour obtenir la liste complète des éléments et attributs disponibles, consultez l’article technique Personnaliser l’interface utilisateur du ruban Office (2007) pour les développeurs (partie 2 sur 3).

Informations de référence sur les classes du ruban

Visual Studio génère la classe Ruban dans le fichier de code du ruban. Ajoutez les méthodes de rappel pour les contrôles du ruban à cette classe. Cette classe implémente l’interface IRibbonExtensibility.

Le tableau suivant décrit les méthodes par défaut de cette classe.

Contenu connexe

• Vue d’ensemble du ruban
• Procédure pas à pas : créer un onglet personnalisé à l’aide du code XML du ruban
• Personnalisation de l’interface utilisateur Office