RibbonCheckBox, interface

Article
05/16/2013

Représente un contrôle Check Box sur un ruban.

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

Syntaxe

'Déclaration
<GuidAttribute("2119eecb-0ee2-4a64-8b87-b76bd1fa395e")> _
Public Interface RibbonCheckBox _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("2119eecb-0ee2-4a64-8b87-b76bd1fa395e")]
public interface RibbonCheckBox : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

Le type RibbonCheckBox expose les membres suivants.

Propriétés

	Nom	Description
	Checked	Obtient ou définit une valeur qui indique si ce RibbonCheckBox est activé.
	Description	Obtient ou définit une description pour ce RibbonCheckBox qui apparaît lorsque la propriété ItemSize de son contrôle parent a la valeur 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.)
	KeyTip	Obtient ou définit le raccourci clavier pour ce RibbonCheckBox.
	Label	Obtient ou définit le texte qui apparaît sur ce RibbonCheckBox.
	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.)
	Position	Obtient ou définit la position de la case à cocher, si la case à cocher est 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	Infrastructure. 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 RibbonCheckBox.
	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 RibbonCheckBox.
	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
	Click	Se produit lorsqu'un utilisateur clique sur la case à cocher.
	Disposed	Représente la méthode qui gère l'événement Disposed d'un composant. (Hérité de IComponent.)

Début

Notes

Vous pouvez 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 affectez à sa propriété Dynamic la valeur true.

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.

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