RibbonGallery, interface

Article
01/06/2014

Représente un contrôle qui affiche un menu d'objets RibbonDropDownItem et de contrôles RibbonButton.

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

Syntaxe

'Déclaration
<GuidAttribute("c1cff037-81e7-44a0-8f9d-150237dfd312")> _
Public Interface RibbonGallery _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("c1cff037-81e7-44a0-8f9d-150237dfd312")]
public interface RibbonGallery : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

Le type RibbonGallery expose les membres suivants.

Propriétés

	Nom	Description
	Buttons	Obtient la collection des boutons dans ce RibbonGallery.
	ColumnCount	Obtient ou définit le nombre de colonnes Item dans ce RibbonGallery.
	ControlSize	Obtient ou définit la taille du contrôle RibbonGallery.
	Description	Obtient ou définit le texte qui apparaît sur ce contrôle RibbonGallery sur un menu ou un bouton partagé.
	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 RibbonGallery dans le gestionnaire d'événements LoadImage.
	ItemImageSize	Obtient ou définit un Size qui donne les dimensions des images affichées par les éléments dans ce RibbonGallery.
	Items	Obtient une collection des composants RibbonDropDownItem dans ce RibbonGallery.
	KeyTip	Obtient ou définit le raccourci clavier pour ce RibbonGallery.
	Label	Obtient ou définit le texte qui apparaît sur ce RibbonGallery.
	Name	Obtient ou définit le nom de ce RibbonComponent. (Hérité de RibbonComponent.)
	OfficeImageId	Obtient ou définit l'image à afficher sur le contrôle 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 l'emplacement de la galerie, si la galerie 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.)
	RowCount	Obtient ou définit le nombre de lignes des composants RibbonDropDownItem que ce RibbonGallery affiche.
	ScreenTip	Obtient ou définit le texte info-bulle qui apparaît lorsque l'utilisateur déplace le pointeur sur ce RibbonGallery.
	SelectedItem	Obtient ou définit l'élément actuellement sélectionné.
	SelectedItemIndex	Obtient ou définit l'index du RibbonDropDownItem sélectionné actuellement.
	ShowImage	Obtient ou définit une valeur qui indique si l'image associée au RibbonGallery est visible.
	ShowItemImage	Obtient ou définit une valeur qui indique si les images sont affichées pour les éléments dans la galerie.
	ShowItemLabel	Obtient ou définit une valeur qui indique si les étiquettes sont affichées pour les éléments sur ce RibbonGallery.
	ShowItemSelection	Obtient ou définit une valeur qui indique si le RibbonDropDownItem actuellement sélectionné se distingue visuellement des autres éléments non sélectionnés.
	ShowLabel	Obtient ou définit une valeur qui indique si l'étiquette de ce RibbonGallery 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 RibbonGallery.
	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
	ButtonClick	Se produit lorsqu'un utilisateur clique sur un bouton sur ce RibbonGallery.
	Click	Se produit lorsqu'un utilisateur clique sur un élément sur ce RibbonGallery.
	Disposed	Représente la méthode qui gère l'événement Disposed d'un composant. (Hérité de IComponent.)
	ItemsLoading	Se produit lorsque ce RibbonGallery est ouvert.

Début

Notes

Comme l'interface RibbonDropDown, RibbonGallery affiche un menu d'objets RibbonDropDownItem et des contrôles RibbonButton.

Contrairement à l'interface RibbonDropDown, l'interface RibbonGallery déclenche des événements Click, plutôt que des événements SelectionChanged, lorsqu'un utilisateur clique sur RibbonDropDownItem. Par exemple, cela signifie que l'événement Click est déclenché deux fois lorsqu'un utilisateur clique deux fois sur le même RibbonDropDownItem. L'événement SelectionChanged est déclenché au maximum une fois lorsque la sélection initiale a été faite pour le même scénario sur un RibbonDropDown en fonction de la sélection avant le premier clic.

La propriété ShowItemSelection contrôle si le RibbonDropDownItem actuellement sélectionné se distingue visuellement des éléments non sélectionnés. Il est possible de sélectionner un seul élément à la fois dans un RibbonGallery.

La propriété ItemImageSize peut être utilisée pour spécifier les tailles d'image autres que 16x16 et 32x32.

Pour ajouter des objets RibbonDropDownItem au moment du design

Cliquez sur la propriété Items dans la fenêtre Propriétés.
Cliquez sur le bouton de sélection (...).
Dans l'Éditeur de collections DropDown, ajoutez, classez et modifiez les nouveaux éléments.

Vous pouvez ajouter des contrôles RibbonButton à un RibbonGallery au moment du design.

Pour ajouter des contrôles RibbonButton au moment du design

Cliquez sur la propriété Buttons dans la fenêtre Propriétés.
Cliquez sur le bouton de sélection (...).
Dans l'Éditeur de collections Button, ajoutez, classez et modifiez les nouveaux contrôles bouton.

Vous pouvez créer un RibbonGallery au moment de l'exécution à l'aide de la méthode CreateRibbonGallery 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.

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.

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.