RibbonButton, classe (System 2007)

Article
08/23/2008

Mise à jour : novembre 2007

Représente un bouton sur un ruban personnalisé.

Espace de noms : Microsoft.Office.Tools.Ribbon
Assembly : Microsoft.Office.Tools.Common.v9.0 (dans Microsoft.Office.Tools.Common.v9.0.dll)

Syntaxe

<ToolboxBitmapAttribute(GetType(RibbonButton), "RibbonButton.bmp")> _
Public NotInheritable Class RibbonButton _
    Inherits RibbonControl

Dim instance As RibbonButton

[ToolboxBitmapAttribute(typeof(RibbonButton), "RibbonButton.bmp")]
public sealed class RibbonButton : RibbonControl

Notes

Visual Studio Tools pour Office crée une instance de la classe RibbonButton lorsque vous faites glisser un contrôle Button de l'onglet Contrôles de ruban Office de la Boîte à outils vers le Concepteur de ruban.

Vous pouvez également créer une instance de ce contrôle au moment de l'exécution et l'ajouter à un menu dynamique. Un menu est dynamique si vous affectez à sa propriété Dynamic la valeur true.

Certaines propriétés de ce contrôle peuvent être définies uniquement avant de charger le ruban dans l'application Office ou avant d'ajouter le contrôle à un menu dynamique au moment de l'exécution. Pour plus d'informations sur la définition de ces propriétés, consultez Vue d'ensemble du modèle objet de ruban.

Tâches courantes

Le tableau suivant répertorie les membres qui sont utiles pour les tâches courantes.

Tâche	Membre
Au moment de l'exécution, ajoutez un bouton à un menu dont la propriété Dynamic a la valeur true.	Créez une instance de la classe RibbonButton à l'aide du constructeur RibbonButton. Ajoutez l'instance à la collection Items du menu.
Modifier la taille du bouton.	Attribuez à ControlSize la valeur de votre choix. Par exemple, pour un grand bouton, affectez-lui la valeur Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Afficher une image sur le bouton.	L'image peut être affichée de trois manières : Utilisez la propriété Image. Vous bénéficiez d'un contrôle plus important avec cette propriété. Affectez à OfficeImageId l'ID d'une image Microsoft Office intégrée que vous souhaitez afficher comme icône pour le bouton. Utilisez la propriété ImageName avec l'événement LoadImage. Cette propriété fournit des avantages en matière de performances.
Désactiver ou masquer des boutons.	Pour désactiver un bouton, affectez la valeur false à Enabled. Pour masquer un bouton, affectez la valeur false à Visible.
Exécuter du code lorsqu'un utilisateur clique sur le bouton.	Ajoutez du code au gestionnaire d'événements Click :

Exemples

L'exemple suivant crée un bouton, définit différentes propriétés du bouton, puis ajoute le bouton à un menu. Pour exécuter cet exemple de code, vous devez exécuter tout d'abord les étapes suivantes :

Ajoutez un élément Ruban (Concepteur visuel) à un projet Visual Studio Tools pour Office.
Ajoutez un groupe à un onglet personnalisé.
Ajoutez un menu au groupe.
Affectez à la propriété Dynamic du menu la valeur true.
Affectez à la propriété ItemSize du menu la valeur RibbonControlSizeLarge.

Private Sub AddButtonsToMenu()
    Dim tempButton As New RibbonButton()
    tempButton.Label = "Button 1"
    tempButton.ControlSize = _
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge
    tempButton.Description = "My Ribbon Button"
    tempButton.ShowImage = True
    tempButton.ShowImage = True
    tempButton.Image = My.Resources.Image1
    tempButton.Image = My.Resources.Image2
    tempButton.KeyTip = "A1"
    menu1.Items.Add(tempButton)
End Sub

private void AddButtonsToMenu()
{
    RibbonButton tempButton = new RibbonButton();
    tempButton.Label = "Button 1";
    tempButton.ControlSize = 
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge;
    tempButton.Description = "My Ribbon Button";
    tempButton.ShowImage = true;
    tempButton.ShowImage = true;
    tempButton.Image = Properties.Resources.Image1;
    tempButton.Image = Properties.Resources.Image2;
    tempButton.KeyTip = "A1";
    menu1.Items.Add(tempButton);

}

Hiérarchie d'héritage

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.Office.Tools.Ribbon.RibbonComponent
        Microsoft.Office.Tools.Ribbon.RibbonControl
          Microsoft.Office.Tools.Ribbon.RibbonButton

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.