RibbonBase Class

Definition

Namespace:

Microsoft.Office.Tools.Ribbon

Assembly:

Microsoft.Office.Tools.Common.v4.0.Utilities.dll

Serves as the base class for Microsoft Office Ribbon customizations.

public ref class RibbonBase abstract : System::ComponentModel::Component, IDisposable, Microsoft::Office::Tools::Ribbon::IRibbonExtension

[System.ComponentModel.ToolboxItem(false)]
public abstract class RibbonBase : System.ComponentModel.Component, IDisposable, Microsoft.Office.Tools.Ribbon.IRibbonExtension

[<System.ComponentModel.ToolboxItem(false)>]
type RibbonBase = class
    inherit Component
    interface IRibbonExtension
    interface IExtension
    interface IDisposable

Public MustInherit Class RibbonBase
Inherits Component
Implements IDisposable, IRibbonExtension

Inheritance

Component

RibbonBase

Attributes

ToolboxItemAttribute

Implements

IExtension IRibbonExtension IDisposable

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

Constructors

RibbonBase(RibbonFactory)

Initializes a new instance of the RibbonBase class.

Properties

Base	Gets the RibbonBase object that this RibbonBase object extends.
Context	Gets the Inspector window, or the Explorer window in Outlook, that is associated with this Ribbon.
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	Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code.
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.

Methods

Dispose(Boolean)	Releases the unmanaged resources used by the RibbonBase class and optionally releases the managed resources.
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.

Events

Close	Occurs when this RibbonBase instance is closing.
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.

Explicit Interface Implementations

IExtension.ExtensionBase