RibbonCheckBox Interface

Définition

Espace de noms:

Microsoft.Office.Tools.Ribbon

Assembly:

Microsoft.Office.Tools.Common.dll

Représente un contrôle de case à cocher sur un ruban.

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

[System.Runtime.InteropServices.Guid("2119eecb-0ee2-4a64-8b87-b76bd1fa395e")]
public interface RibbonCheckBox : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("2119eecb-0ee2-4a64-8b87-b76bd1fa395e")>]
type RibbonCheckBox = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonCheckBox
Implements IComponent, IDisposable, RibbonControl

Attributs

GuidAttribute

Implémente

RibbonComponent RibbonControl IComponent IDisposable

Remarques

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 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 RibbonCheckBox au moment de l’exécution à l’aide de la CreateRibbonCheckBox 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.

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

Checked	Obtient ou définit une valeur qui indique si cette RibbonCheckBox est cochée.
Description	Obtient ou définit la description de cette RibbonCheckBox qui s’affiche lorsque la propriété ItemSize de son contrôle parent est définie sur 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 de cette RibbonCheckBox.
Label	Obtient ou définit le texte qui apparaît dans cette 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 celle-ci figure 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	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 la RibbonCheckBox.
SuperTip	Obtient ou définit le texte info-bulle multiligne qui apparaît lorsque l’utilisateur déplace le pointeur sur la RibbonCheckBox.
Tag	Obtient ou définit des données propres à 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)

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

Click

Se produit quand un utilisateur clique sur la case à cocher.