RibbonBase Class

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
Public method RibbonBase Infrastructure. Initializes a new instance of the RibbonBase class.

Top

Properties

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

Top

Methods

  Name Description
Public method CreateObjRef Security Critical. Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public method Dispose() Releases all resources used by the Component. (Inherited from Component.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the RibbonBase class and optionally releases the managed resources. (Overrides Component.Dispose(Boolean).)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetLifetimeService Security Critical. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method GetService Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Security Critical. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Public method 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.
Public method PerformLayout Refreshes the Ribbon user interface.
Public method ResumeLayout() Reverses the effect of the SuspendLayout method.
Public method ResumeLayout(Boolean) Reverses the effect of the SuspendLayout method.
Public method SuspendLayout Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon.
Public method 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
Public event Close Occurs when this RibbonBase instance is closing.
Public event Disposed Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public event Load Occurs when the RibbonBase is loaded into the Microsoft Office application.
Public event LoadImage Occurs when the RibbonBase loads, if the ImageName property is set for one or more controls.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate property 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 and the .NET Framework 4.5. 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.

See Also

Reference

Microsoft.Office.Tools.Ribbon Namespace