RibbonButton Interface

Définition

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

GuidAttribute

Implémente

RibbonComponent RibbonControl IComponent IDisposable

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.

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

Méthodes

Événements

S’applique à