RibbonMenu Interface

Référence

Définition

Espace de noms:: Microsoft.Office.Tools.Ribbon

Assembly:: Microsoft.Office.Tools.Common.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Représente un menu sur un onglet de ruban ou dans le menu Microsoft Office.

public interface class RibbonMenu : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonControl, System::ComponentModel::IComponent

[System.Runtime.InteropServices.Guid("59dc7f42-aca2-484a-9622-1ee34a6cfd7d")]
public interface RibbonMenu : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("59dc7f42-aca2-484a-9622-1ee34a6cfd7d")>]
type RibbonMenu = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonMenu
Implements IComponent, IDisposable, RibbonControl

Attributs: GuidAttribute

Implémente: RibbonComponent RibbonControl IComponent IDisposable

Exemples

L’exemple suivant montre comment ajouter et remplir un sous-menu à un menu existant au moment de l’exécution.

Pour obtenir un exemple plus riche qui met à jour les contrôles au moment de l’exécution et implique l’obtention de données à partir de l’exemple de base de données AdventureWorks à l’aide de Language-Integrated Query (LINQ), consultez Procédure pas à pas : mise à jour des contrôles sur un ruban au moment de l’exécution.

Pour exécuter cet exemple de code, vous devez d’abord effectuer les étapes suivantes :

Ajoutez un élément ruban (Visual Designer) à un projet Office.
Ajoutez un groupe à l’onglet personnalisé.
Ajoutez un menu au groupe.
Définissez la propriété (Nom) du menu sur CustomerMenu.
Définissez la propriété Label du menu sur Clients.
Définissez la propriété Dynamic du menu sur true.

Vous pouvez maintenant ajouter et supprimer des contrôles dans le menu au moment de l'exécution, après le chargement du ruban dans l'application Office.

private void PopulateCustomerMenu()
{
    // Add two sub-menus to EmployeeMenu and populate each sub-menu
    // First sub-menu
    RibbonMenu subMenu1 = this.Factory.CreateRibbonMenu();
    subMenu1.Dynamic = true;
    subMenu1.Label = "A - M";
    subMenu1.Items.Add(this.Factory.CreateRibbonToggleButton());
    ((RibbonToggleButton)subMenu1.Items.Last()).Label = "Hall, Don";
    subMenu1.Items.Add(this.Factory.CreateRibbonToggleButton());
    ((RibbonToggleButton)subMenu1.Items.Last()).Label = "Valdez, Rachel";
    CustomerMenu.Items.Add(subMenu1);

    // Second sub-menu
    RibbonMenu subMenu2 = this.Factory.CreateRibbonMenu();
    subMenu2.Dynamic = true;
    subMenu2.Label = "N - Z";
    subMenu2.Items.Add(this.Factory.CreateRibbonToggleButton());
    ((RibbonToggleButton)subMenu2.Items.Last()).Label = "Robinson, Alex";
    CustomerMenu.Items.Add(subMenu2);
}

Private Sub PopulateCustomerMenu()
    ' Add two sub-menus to EmployeeMenu and populate each sub-menu
    ' First sub-menu
    Dim subMenu1 As RibbonMenu = Me.Factory.CreateRibbonMenu()
    subMenu1.Dynamic = True
    subMenu1.Label = "A - M"
    subMenu1.Items.Add(Me.Factory.CreateRibbonToggleButton())
    CType(subMenu1.Items.Last(), RibbonToggleButton).Label = "Hall, Don"
    subMenu1.Items.Add(Me.Factory.CreateRibbonToggleButton())
    CType(subMenu1.Items.Last(), RibbonToggleButton).Label = "Valdez, Rachel"
    CustomerMenu.Items.Add(subMenu1)

    ' Second sub-menu
    Dim subMenu2 As RibbonMenu = Me.Factory.CreateRibbonMenu()
    subMenu2.Dynamic = True
    subMenu2.Label = "N - Z"
    subMenu2.Items.Add(Me.Factory.CreateRibbonToggleButton())
    CType(subMenu2.Items.Last(), RibbonToggleButton).Label = "Robinson, Alex"
    CustomerMenu.Items.Add(subMenu2)

End Sub

Remarques

Visual Studio crée un RibbonMenu objet lorsque vous faites glisser un contrôle Menu de l’onglet Contrôles du ruban Office de la boîte à outils vers le ruban Designer.

Vous pouvez créer un RibbonMenu au moment de l’exécution à l’aide de la CreateRibbonMenu 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. Toutes ces tâches peuvent être effectuées au moment de la conception. Certaines de ces tâches peuvent être effectuées au moment de l’exécution 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, consultez Vue d’ensemble du modèle objet du ruban.

Tâche	Membre
Afficher une image dans le menu.	Utilisez la Image propriété ou ImageName . Vous pouvez également réutiliser les images qui apparaissent dans les contrôles de ruban intégrés. Pour ce faire, 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 menu.
Modifiez la taille du menu.	Définissez la ControlSize propriété sur la valeur souhaitée. Par exemple, pour un menu volumineux, définissez-le sur `Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge`.
Modifiez la taille des éléments dans le menu.	Définissez la ItemSize propriété sur la valeur souhaitée. Par exemple, pour afficher des éléments plus volumineux, définissez-le sur `Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge`.
Activer les modifications apportées au menu au moment de l’exécution (par exemple, pour activer l’ajout de contrôles au menu au moment de l’exécution).	Définissez la propriété Dynamic sur `true`.
Accédez aux contrôles dans le menu, ajoutez des contrôles au menu ou supprimez des contrôles du menu.	Utilisez la propriété Items.
Ajoutez un menu au menu Microsoft Office, à un groupe ou à un autre contrôle qui peut contenir des menus.	Ajoutez un RibbonMenu à la `Items` propriété du menu, du groupe ou du contrôle Microsoft Office.

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 menu.
Description	Obtient ou définit le texte affiché dans le menu actuel.
Dynamic	Obtient ou définit une valeur qui indique si le menu peut être modifié au moment de l’exécution.
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 menu.
ImageName	Obtient ou définit le nom que vous pouvez utiliser dans le gestionnaire d’événements LoadImage pour identifier une image pour le menu.
Items	Obtient la collection des contrôles du menu.
ItemSize	Obtient ou définit la taille des contrôles du menu.
KeyTip	Obtient ou définit la touche clavier d’accès rapide du menu.
Label	Obtient ou définit le texte affiché par le menu.
Name	Obtient ou définit le nom de ce RibbonComponent. (Hérité de RibbonComponent)
OfficeImageId	Obtient ou définit l’image à afficher sur le menu 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 menu s'il est affiché sur 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 menu.
ShowImage	Obtient ou définit une valeur qui indique si l'image associée au menu est visible.
ShowLabel	Obtient ou définit une valeur qui indique si l’étiquette du menu est visible.
SuperTip	Obtient ou définit le texte info-bulle multiligne qui apparaît lorsque l’utilisateur déplace le pointeur sur le menu.
Tag	Obtient ou définit des données propres à l’application associées à ce RibbonComponent. (Hérité de RibbonComponent)
Title	Obtient ou définit le titre affiché lorsque l’utilisateur développe un menu ajouté au menu Microsoft Office.
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

ItemsLoading

Se produit lorsque les contrôles ou menus imbriqués sont chargés dans le menu actuel au moment de l’exécution.

S’applique à