Partager via


RibbonButton Interface

Définition

Représente un bouton sur un ruban personnalisé.

public interface class RibbonButton : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonControl, System::ComponentModel::IComponent
[System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent
[<System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")>]
type RibbonButton = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable
Public Interface RibbonButton
Implements IComponent, IDisposable, RibbonControl
Attributs
Implémente

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 d’abord effectuer les étapes suivantes :

  1. Ajoutez un élément de ruban (Visual Designer) à un projet créé à l’aide des outils de développement Office dans Visual Studio.

  2. Ajoutez un groupe à l’onglet personnalisé.

  3. Ajoutez un menu au groupe.

  4. Définissez la propriété Dynamic du menu sur true.

  5. Définissez la propriété ItemSize du menu sur RibbonControlSizeLarge.

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);

}
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

Remarques

Visual Studio crée un instance d’une classe qui implémente l’interface RibbonButton lorsque vous faites glisser un contrôle Button de l’onglet Contrôles du ruban Office de la boîte à outils vers le ruban Designer.

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 définissez sa Dynamic propriété sur true.

Certaines propriétés de ce contrôle peuvent être définies uniquement avant le chargement du ruban dans l’application Office ou avant l’ajout du 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 du ruban.

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

Il existe deux façons d'accéder à l'objet RibbonFactory :

  • À l'aide de la propriété Factory de la classe Ribbon. Utilisez cette approche basée sur le code dans votre classe Ribbon.

  • À l'aide de la méthode Globals.Factory.GetRibbonFactory. Utilisez cette approche basée sur le code hors de votre classe Ribbon.

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 Dynamic propriété est définie sur true. Crée une instance d'une classe qui RibbonButton implémente l'interface CreateRibbonButton.

de la RibbonFactory classe . Pour plus d'informations sur, consultez Accès global aux objets dans les projets Office.

Ajoutez le instance à la collection du Items menu.
Modifiez la taille du bouton. ControlSize Valeur à tester Par exemple, pour un bouton volumineux, définissez-le sur Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Afficher une image sur le bouton. Il existe trois façons d’afficher une image :

- Utilisez la Image propriété . Cette propriété offre le plus de contrôle.
- Définissez OfficeImageId sur l’ID d’une image Microsoft Office intégrée que vous souhaitez afficher en tant qu’icône pour le bouton.
- Utilisez la ImageName propriété avec l’événement LoadImage . Cette propriété offre des avantages en matière de performances.
Désactiver ou masquer les boutons. Pour désactiver un bouton, définissez sur Enabledfalse.

Pour masquer un bouton, définissez sur Visiblefalse.
Exécutez 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 Visual Studio Tools for Office Runtime Overview.

Utilisation

Cette documentation décrit la version de ce type utilisée dans les projets Office qui ciblent le .NET Framework 4 ou ultérieur. 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 : http://go.microsoft.com/fwlink/?LinkId=160658.

Propriétés

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 ItemSize propriété du menu est définie sur Microsoft.Office.Core.RibbonControlSize.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

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.

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 propres à 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)

Méthodes

PerformDynamicLayout()

Appelle la méthode Microsoft.Office.Core.IRibbonUI.InvalidateControl du contrôle parent, si le RibbonComponent a un parent dynamique, tel qu’un menu dynamique, et que 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 disposition 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)

Événements

Click

Se produit lorsque l'utilisateur clique sur le bouton.

S’applique à