Partager via

RibbonBase, classe

  • Article

Sert de classe de base pour les personnalisations de ruban Microsoft Office.

Hiérarchie d'héritage

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.Office.Tools.Ribbon.RibbonBase

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

Syntaxe

'Déclaration
Public MustInherit Class RibbonBase _
    Inherits Component _
    Implements IRibbonExtension, IExtension, IDisposable

public abstract class RibbonBase : Component, 
    IRibbonExtension, IExtension, IDisposable

Le type RibbonBase expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique RibbonBase Infrastructure. Initialise une nouvelle instance de la classe RibbonBase.

Début

Propriétés

  Nom Description
Propriété publique Base Obtient l'objet RibbonBase que cet objet RibbonBase étend.
Propriété protégée CanRaiseEvents Obtient une valeur qui indique si le composant peut déclencher un événement. (Hérité de Component.)
Propriété publique Container Obtient le IContainer qui contient Component. (Hérité de Component.)
Propriété publique Context Obtient la fenêtre Inspecteur ou Explorateur dans Outlook, qui est associée à ce ruban.
Propriété protégée DesignMode Obtient une valeur qui indique si Component est actuellement en mode design. (Hérité de Component.)
Propriété protégée Events Obtient la liste des gestionnaires d'événements attachés à ce Component. (Hérité de Component.)
Propriété publique Factory Obtient ou définit la fabrique de rubans associée à ce RibbonBase.
Propriété publique Global Obtient ou définit une valeur qui détermine si ce RibbonBase peut être utilisé simultanément dans plusieurs contextes.
Propriété publique Name Obtient ou définit le nom de ce RibbonBase.
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 du RibbonComponent de ce RibbonBase.
Propriété publique RibbonId Obtient l'ID de ruban qui a été utilisé pour créer cette instance de la classe RibbonBase.
Propriété publique RibbonType Obtient une liste séparée par des virgules des ID de ruban associés à cette instance RibbonBase.
Propriété publique RibbonUI Infrastructure. Obtient l'instance IRibbonUI fournie par l'application Microsoft Office au code d'extensibilité du ruban.
Propriété publique Site Obtient ou définit le ISite de Component. (Hérité de Component.)
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 RibbonBase.

Début

Méthodes

  Nom Description
Méthode publique CreateObjRef Essentiel pour la sécurité. Crée un objet contenant toutes les informations appropriées requises pour générer un proxy permettant de communiquer avec un objet distant. (Hérité de MarshalByRefObject.)
Méthode publique Dispose() Libère toutes les ressources utilisées par Component. (Hérité de Component.)
Méthode protégée Dispose(Boolean) Libère les ressources non managées utilisées par la classe RibbonBase et libère éventuellement les ressources managées. (Substitue Component.Dispose(Boolean).)
Méthode publique Equals Détermine si l'objet spécifié est identique à l'objet actuel. (Hérité de Object.)
Méthode protégée Finalize Libère les ressources non managées et exécute d'autres opérations de nettoyage avant la récupération de Component par le garbage collection. (Hérité de Component.)
Méthode publique GetHashCode Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
Méthode publique GetLifetimeService Essentiel pour la sécurité. Récupère l'objet de service de durée de vie en cours qui contrôle la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject.)
Méthode protégée GetService Retourne un objet qui représente un service fourni par Component ou par son Container. (Hérité de Component.)
Méthode publique GetType Obtient le Type de l'instance actuelle. (Hérité de Object.)
Méthode publique InitializeLifetimeService Essentiel pour la sécurité. Obtient un objet de service de durée de vie pour contrôler la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject.)
Méthode protégée MemberwiseClone() Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
Méthode protégée MemberwiseClone(Boolean) Crée une copie superficielle de l'objet MarshalByRefObject actuel. (Hérité de MarshalByRefObject.)
Méthode publique PerformDynamicLayout Appelle la méthode Microsoft.Office.Core.IRibbonUI.InvalidateControl du contrôle parent si le RibbonComponent du RibbonBase possède un parent dynamique, tel qu'un menu dynamique, et si la disposition n'est pas interrompue.
Méthode publique PerformLayout Actualise l'interface utilisateur du ruban.
Méthode publique ResumeLayout() Inverse l'effet de la méthode SuspendLayout.
Méthode publique ResumeLayout(Boolean) Inverse l'effet de la méthode SuspendLayout.
Méthode publique SuspendLayout Empêche l'application Microsoft Office d'actualiser l'état des contrôles sur le ruban.
Méthode publique ToString Retourne String contenant le nom du Component, s'il existe.Cette méthode ne doit pas être substituée. (Hérité de Component.)

Début

Événements

  Nom Description
Événement public Close Se produit lorsque cette instance RibbonBase se ferme.
Événement public Disposed Se produit lorsque le composant est supprimé par un appel à la méthode Dispose. (Hérité de Component.)
Événement public Load Se produit lorsque le RibbonBase est chargé dans l'application Microsoft Office.
Événement public LoadImage Se produit lorsque le RibbonBase charge, si la propriété ImageName est définie pour un ou plusieurs contrôles.

Début

Implémentations d'interface explicite

  Nom Description
Implémentation d'interface explicitePropriété privée IExtension.ExtensionBase Infrastructure.

Début

Notes

Lorsque vous ajoutez un nouvel élément Ruban (Concepteur visuel) à un projet Office, Visual Studio ajoute une classe Ruban qui hérite de RibbonBase au projet.Le RibbonBase contient des méthodes et des propriétés qui sont communes à toutes les classes de ruban.Pour plus d'informations, consultez Concepteur de ruban.

Certaines propriétés de cette RibbonBase 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.

Utilisation

Ce type est utilisé uniquement dans les projets Office qui ciblent .NET Framework 4 et .NET Framework 4.5. L'assembly qui définit ce type ne fait pas partie de Visual Studio Tools pour Office runtime. Vous devez déployer cet assembly avec votre solution. Pour plus d'informations, consultez Assemblys dans Visual Studio Tools pour Office Runtime.

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Voir aussi

Référence

Microsoft.Office.Tools.Ribbon, espace de noms