We recommend using Visual Studio 2017
This documentation is archived and is not being maintained.

RibbonBase Class

Serves as the base class for Microsoft Office Ribbon customizations.


Namespace:  Microsoft.Office.Tools.Ribbon
Assembly:  Microsoft.Office.Tools.Common.v4.0.Utilities (in Microsoft.Office.Tools.Common.v4.0.Utilities.dll)

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

The RibbonBase type exposes the following members.

Public methodRibbonBaseInfrastructure. Initializes a new instance of the RibbonBase class.

Public propertyBaseGets the RibbonBase object that this RibbonBase object extends.
Protected propertyCanRaiseEventsGets a value indicating whether the component can raise an event. (Inherited from Component.)
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyContextGets the Inspector window, or the Explorer window in Outlook, that is associated with this Ribbon.
Protected propertyDesignModeGets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Protected propertyEventsGets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public propertyFactoryGets or sets the Ribbon factory that is associated with this RibbonBase.
Public propertyGlobalGets or sets a value that determines whether this RibbonBase can be used in multiple contexts simultaneously.
Public propertyNameGets or sets the name of this RibbonBase.
Public propertyOfficeMenuGets a RibbonOfficeMenu that represents the Microsoft Office Menu customization.
Public propertyParentGets a RibbonComponent that represents the parent of the RibbonComponent of this RibbonBase.
Public propertyRibbonIdGets the Ribbon ID that was used to create this instance of the RibbonBase class.
Public propertyRibbonTypeGets a comma-separated list of Ribbon IDs that are associated with this RibbonBase instance.
Public propertyRibbonUIInfrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code.
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Public propertyStartFromScratchGets or sets a value that indicates whether to hide all built-in tabs on the Ribbon and most commands on the Microsoft Office Menu and display only the customizations that are defined in this Ribbon item.
Public propertyTabsGets a collection of RibbonTab objects in the RibbonOfficeMenu.
Public propertyTagGets or sets application-specific data that is associated with this RibbonBase.

Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the RibbonBase class and optionally releases the managed resources. (Overrides Component.Dispose(Boolean).)
Public methodEqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodGetServiceReturns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public methodPerformDynamicLayoutCalls the Microsoft.Office.Core.IRibbonUI.InvalidateControl method of the parent control if the RibbonComponent of the RibbonBase has a dynamic parent, such as a dynamic menu, and layout is not suspended.
Public methodPerformLayoutRefreshes the Ribbon user interface.
Public methodResumeLayout()Reverses the effect of the SuspendLayout method.
Public methodResumeLayout(Boolean)Reverses the effect of the SuspendLayout method.
Public methodSuspendLayoutPrevents the Microsoft Office application from refreshing the state of controls on the Ribbon.
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Public eventCloseOccurs when this RibbonBase instance is closing.
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public eventLoadOccurs when the RibbonBase is loaded into the Microsoft Office application.
Public eventLoadImageOccurs when the RibbonBase loads, if the ImageName property is set for one or more controls.

When you add a new Ribbon (Visual Designer) item to an Office project, Visual Studio adds a Ribbon class that inherits from RibbonBase to the project. RibbonBase contains methods and properties that are common to all Ribbon classes. For more information, see Ribbon Designer.

Some properties of RibbonBase can be set only before the Ribbon is loaded into the Office application. For information about setting these properties, see Ribbon Object Model Overview.


This type is used only in Office projects that target the .NET Framework 4. The assembly that defines this type is not part of the Visual Studio Tools for Office runtime. You must deploy this assembly with your solution. For more information, see Assemblies in the Visual Studio Tools for Office Runtime.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.