RibbonButton, interface

Article
01/06/2014

Représente un bouton sur un ruban personnalisé.

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

Syntaxe

'Déclaration
<GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")> _
Public Interface RibbonButton _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

Le type RibbonButton expose les membres suivants.

Propriétés

	Nom	Description
	ControlSize	Obtient ou définit la taille du bouton.
	Description	Obtient ou définit le texte qui apparaît sur ce bouton dans un menu lorsque la propriété ItemSize du menu a la valeur Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
	Enabled	Obtient ou définit une valeur qui indique si ce RibbonControl est activé. (Hérité de RibbonControl.)
	Id	Obtient une chaîne que Microsoft Office utilise pour identifier cet objet RibbonControl. (Hérité de RibbonControl.)
	Image	Obtient ou définit l'image affichée sur le bouton.
	ImageName	Obtient ou définit le nom que vous pouvez utiliser pour identifier le bouton dans le gestionnaire d'événements LoadImage.
	KeyTip	Obtient ou définit le raccourci clavier du bouton.
	Label	Obtient ou définit le texte affiché sur le bouton.
	Name	Obtient ou définit le nom de ce RibbonComponent. (Hérité de RibbonComponent.)
	OfficeImageId	Obtient ou définit l'image à afficher sur le bouton, si vous souhaitez utiliser une icône Microsoft Office intégrée.
	Parent	Obtient un RibbonComponent qui représente le parent de ce RibbonComponent. (Hérité de RibbonComponent.)
	Position	Obtient ou définit la position du bouton si le bouton est dans le menu Microsoft Office.
	Ribbon	Obtient l'objet Ribbon de niveau supérieur qui contient la hiérarchie des contrôles. (Hérité de RibbonComponent.)
	RibbonUI	Infrastructure. Obtient l'instance IRibbonUI fournie par l'application Microsoft Office au code d'extensibilité du ruban. (Hérité de RibbonComponent.)
	ScreenTip	Obtient ou définit le texte info-bulle qui apparaît lorsque l'utilisateur déplace le pointeur sur le bouton.
	ShowImage	Obtient ou définit une valeur qui indique si l'image associée au bouton est visible.
	ShowLabel	Obtient ou définit une valeur qui indique si l'étiquette pour le bouton est visible.
	Site	Obtient ou définit le ISite associé à IComponent. (Hérité de IComponent.)
	SuperTip	Obtient ou définit le texte info-bulle multiligne qui apparaît lorsque l'utilisateur déplace le pointeur sur le bouton.
	Tag	Obtient ou définit des données spécifiques à l'application associées à ce RibbonComponent. (Hérité de RibbonComponent.)
	Visible	Obtient ou définit une valeur qui indique si ce RibbonControl est visible. (Hérité de RibbonControl.)

Début

Méthodes

	Nom	Description
	Dispose	Exécute les tâches définies par l'application associées à la libération ou à la redéfinition des ressources non managées. (Hérité de IDisposable.)
	PerformDynamicLayout	Appelle la méthode Microsoft.Office.Core.IRibbonUI.InvalidateControl du contrôle parent si RibbonComponent possède un parent dynamique, tel qu'un menu dynamique, et si la disposition n'est pas interrompue. (Hérité de RibbonComponent.)
	PerformLayout	Appelle Microsoft.Office.Core.IRibbonUI.InvalidateControl si le RibbonComponent a un parent et que la mise en page n'est pas interrompue. (Hérité de RibbonComponent.)
	ResumeLayout()	Inverse l'effet de la méthode SuspendLayout. (Hérité de RibbonComponent.)
	ResumeLayout(Boolean)	Inverse l'effet de la méthode SuspendLayout. (Hérité de RibbonComponent.)
	SuspendLayout	Empêche l'application Microsoft Office d'actualiser l'état des contrôles sur le ruban. (Hérité de RibbonComponent.)

Début

Événements

	Nom	Description
	Click	Se produit lorsque l'utilisateur clique sur le bouton.
	Disposed	Représente la méthode qui gère l'événement Disposed d'un composant. (Hérité de IComponent.)

Début

Notes

Visual Studio crée une instance d'une classe qui implémente l'interface RibbonButton lorsque vous faites glisser un contrôle Button de l'onglet Contrôles de ruban Office de la Boîte à outils sur 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.

Vous pouvez créer un RibbonButton au moment de l'exécution à l'aide de la méthode CreateRibbonButton de l'objet RibbonFactory.

Il existe deux méthodes pour accéder à l'objet RibbonFactory :

En utilisant la propriété Factory de la classe du ruban. Utilisez cette approche depuis le code dans votre classe de ruban.
En utilisant la méthode Globals.Factory.GetRibbonFactory. Utilisez cette approche depuis le code en dehors de votre classe 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 d'une classe qui implémente l'interface RibbonButton à l'aide du CreateRibbonButton méthode de la classe RibbonFactory. Pour plus d'informations, consultez Accès global aux objets dans les projets Office. 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 :

Notes

Cette interface est implémentée par Visual Studio Tools pour Office Runtime. Elle n'est pas destinée à être implémentée dans votre code. Pour plus d'informations, consultez Vue d'ensemble de Visual Studio Tools pour Office Runtime.

Utilisation

Cette documentation décrit la version de ce type utilisée dans les projets Office qui ciblent .NET Framework 4 et .NET Framework 4.5. Dans les projets qui ciblent .NET Framework 3.5, ce type peut contenir d'autres membres, et les exemples de code qui y figurent sont susceptibles de ne pas fonctionner. Pour obtenir de la documentation sur ce type dans les projets ciblant .NET Framework 3.5, consultez la section de référence suivante dans la documentation Visual Studio 2008 : https://go.microsoft.com/fwlink/?LinkId=160658.

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 créé en utilisant les outils de développement Office dans Visual Studio.
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 = Me.Factory.CreateRibbonButton()
    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 = this.Factory.CreateRibbonButton();
    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);

}