OfficeRibbon, interface

Représente une personnalisation de ruban Microsoft Office créée à l'aide du concepteur de ruban dans un projet Office dans Visual Studio.

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

Syntaxe

'Déclaration
<GuidAttribute("49fbf223-6d24-4c4b-9101-2d5833434328")> _
Public Interface OfficeRibbon _
    Inherits RibbonComponent, IComponent, IDisposable
[GuidAttribute("49fbf223-6d24-4c4b-9101-2d5833434328")]
public interface OfficeRibbon : RibbonComponent, 
    IComponent, IDisposable

Le type OfficeRibbon expose les membres suivants.

Propriétés

  Nom Description
Propriété publique Context Obtient la fenêtre Inspecteur ou Explorateur dans Outlook, qui est associée à ce ruban.
Propriété publique DefaultExtension Obtient l'extension par défaut de cet objet OfficeRibbon.
Propriété publique Extension Obtient une extension personnalisée pour cet objet OfficeRibbon.
Propriété publique Global Obtient ou définit une valeur qui détermine si ce OfficeRibbon peut être utilisé simultanément dans plusieurs contextes.
Propriété publique Name Obtient ou définit le nom de ce RibbonComponent. (Hérité de RibbonComponent.)
Propriété publique OfficeMenu Obtient un RibbonOfficeMenu qui représente la personnalisation du menu Microsoft Office.
Propriété publique Parent Obtient un RibbonComponent qui représente le parent de ce RibbonComponent. (Hérité de RibbonComponent.)
Propriété publique Ribbon Obtient l'objet Ribbon de niveau supérieur qui contient la hiérarchie des contrôles. (Hérité de RibbonComponent.)
Propriété publique RibbonId Obtient l'ID de ruban utilisé pour créer cette instance de l'objet OfficeRibbon.
Propriété publique RibbonType Obtient une liste séparée par des virgules des ID de ruban associés à cette instance OfficeRibbon.
Propriété publique RibbonUI Infrastructure. Obtient l'instance IRibbonUI fournie par l'application Microsoft Office au code d'extensibilité du ruban. (Hérité de RibbonComponent.)
Propriété publique Site Obtient ou définit le ISite associé à IComponent. (Hérité de IComponent.)
Propriété publique StartFromScratch Obtient ou définit une valeur qui indique s'il faut masquer tous les onglets intégrés sur le ruban et la plupart des commandes sur le menu Microsoft Office et afficher uniquement les personnalisations définies dans cet élément de ruban.
Propriété publique Tabs Obtient une collection des objets RibbonTab dans le RibbonOfficeMenu.
Propriété publique Tag Obtient ou définit des données spécifiques à l'application associées à ce RibbonComponent. (Hérité de RibbonComponent.)

Début

Méthodes

  Nom Description
Méthode publique 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.)
Méthode publique 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.)
Méthode publique 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.)
Méthode publique ResumeLayout() Inverse l'effet de la méthode SuspendLayout. (Hérité de RibbonComponent.)
Méthode publique ResumeLayout(Boolean) Inverse l'effet de la méthode SuspendLayout. (Hérité de RibbonComponent.)
Méthode publique 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
Événement public Close Se produit lorsque cette instance OfficeRibbon se ferme.
Événement public Disposed Représente la méthode qui gère l'événement Disposed d'un composant. (Hérité de IComponent.)
Événement public Load Se produit lorsque le OfficeRibbon est chargé dans l'application Microsoft Office.
Événement public LoadImage Se produit lorsque le OfficeRibbon charge, si la propriété ImageName est définie pour un ou plusieurs contrôles.

Début

Notes

Généralement, l'interface OfficeRibbon n'est pas utilisée directement. À la place, utilisez la classe du ruban que Visual Studio génère lorsque vous ajoutez un nouvel élément Ruban (Concepteur de Visual) à votre projet. Vous pouvez accomplir la plupart des tâches relatives au ruban à l'aide des événements et des propriétés dans la classe du ruban générée.

La classe de ruban de transformation générée hérite de la classe RibbonBase. Cette classe de base redirige des appels généraux à ses membres vers une implémentation interne de l'interface OfficeRibbon dans Visual Studio Tools pour Office Runtime. Si vous souhaitez utiliser l'objet OfficeRibbon directement, utilisez la propriété Base de la classe du ruban générée.

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. 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.

Voir aussi

Référence

Microsoft.Office.Tools.Ribbon, espace de noms