RibbonBase Class

Article
07/25/2011

Serves as the base class for Microsoft Office Ribbon customizations.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public MustInherit Class RibbonBase _
    Inherits Component _
    Implements IRibbonExtension, IExtension, IDisposable

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

The RibbonBase type exposes the following members.

Constructors

	Name	Description
	RibbonBase	Infrastructure. Initializes a new instance of the RibbonBase class.

Top

Properties

	Name	Description
	Base	Gets the RibbonBase object that this RibbonBase object extends.
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component.)
	Container	Gets the IContainer that contains the Component. (Inherited from Component.)
	Context	Gets the Inspector window, or the Explorer window in Outlook, that is associated with this Ribbon.
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
	Factory	Gets or sets the Ribbon factory that is associated with this RibbonBase.
	Global	Gets or sets a value that determines whether this RibbonBase can be used in multiple contexts simultaneously.
	Name	Gets or sets the name of this RibbonBase.
	OfficeMenu	Gets a RibbonOfficeMenu that represents the Microsoft Office Menu customization.
	Parent	Gets a RibbonComponent that represents the parent of the RibbonComponent of this RibbonBase.
	RibbonId	Gets the Ribbon ID that was used to create this instance of the RibbonBase class.
	RibbonType	Gets a comma-separated list of Ribbon IDs that are associated with this RibbonBase instance.
	RibbonUI	Infrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code.
	Site	Gets or sets the ISite of the Component. (Inherited from Component.)
	StartFromScratch	Gets 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.
	Tabs	Gets a collection of RibbonTab objects in the RibbonOfficeMenu.
	Tag	Gets or sets application-specific data that is associated with this RibbonBase.

Top

Methods

	Name	Description
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	Dispose()	Releases all resources used by the Component. (Inherited from Component.)
	Dispose(Boolean)	Releases the unmanaged resources used by the RibbonBase class and optionally releases the managed resources. (Overrides Component.Dispose(Boolean).)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetService	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	PerformDynamicLayout	Calls 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.
	PerformLayout	Refreshes the Ribbon user interface.
	ResumeLayout()	Reverses the effect of the SuspendLayout method.
	ResumeLayout(Boolean)	Reverses the effect of the SuspendLayout method.
	SuspendLayout	Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon.
	ToString	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Top

Events

	Name	Description
	Close	Occurs when this RibbonBase instance is closing.
	Disposed	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
	Load	Occurs when the RibbonBase is loaded into the Microsoft Office application.
	LoadImage	Occurs when the RibbonBase loads, if the ImageName property is set for one or more controls.

Top

Explicit Interface Implementations

	Name	Description
	IExtension.ExtensionBase	Infrastructure.

Top

Remarks

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.

Usage

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.

Thread Safety

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

Share via