RibbonBox, interface

Article
05/16/2013

Réorganise et aligne des contrôles 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("e351eac0-961f-458a-8811-58090e3198ef")> _
Public Interface RibbonBox _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("e351eac0-961f-458a-8811-58090e3198ef")]
public interface RibbonBox : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

Le type RibbonBox expose les membres suivants.

Propriétés

	Nom	Description
	BoxStyle	Obtient une valeur RibbonBoxStyle qui indique si les contrôles placés sur ce RibbonBox seront disposés horizontalement ou verticalement.
	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.)
	Items	Obtient une collection des contrôles situés sur cet objet RibbonBox.
	Name	Obtient ou définit le nom de ce RibbonComponent. (Hérité de RibbonComponent.)
	Parent	Obtient un RibbonComponent qui représente le parent de ce RibbonComponent. (Hérité de RibbonComponent.)
	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.)
	Site	Obtient ou définit le ISite associé à IComponent. (Hérité de IComponent.)
	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
	Disposed	Représente la méthode qui gère l'événement Disposed d'un composant. (Hérité de IComponent.)

Début

Notes

Le RibbonBox aligne automatiquement les contrôles de ruban lorsque vous les déposez sur celui-ci.

Utilisez la propriété BoxStyle pour disposer les contrôles enfants horizontalement (valeur par défaut) ou verticalement.Si les contrôles sont configurés pour être disposés verticalement et que l'espace n'est pas suffisant, ils sont disposés sur plusieurs colonnes.

Certaines propriétés de ce contrôle peuvent être définies uniquement avant de charger le ruban dans l'application Office.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 RibbonBox au moment de l'exécution à l'aide de la méthode CreateRibbonBox 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.

[!REMARQUE]

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.