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)

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

[ToolboxItemAttribute(false)]
public abstract class RibbonBase : Component, IRibbonExtension, 
	IExtension, IDisposable

NameDescription
System_CAPS_pubmethodRibbonBase(RibbonFactory)

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the RibbonBase class.

NameDescription
System_CAPS_pubpropertyBase

Gets the RibbonBase object that this RibbonBase object extends.

System_CAPS_protpropertyCanRaiseEvents

(Inherited from Component.)

System_CAPS_pubpropertyContainer

(Inherited from Component.)

System_CAPS_pubpropertyContext

Gets the Inspector window, or the Explorer window in Outlook, that is associated with this Ribbon.

System_CAPS_protpropertyDesignMode

(Inherited from Component.)

System_CAPS_protpropertyEvents

(Inherited from Component.)

System_CAPS_pubpropertyFactory

Gets or sets the Ribbon factory that is associated with this RibbonBase.

System_CAPS_pubpropertyGlobal

Gets or sets a value that determines whether this RibbonBase can be used in multiple contexts simultaneously.

System_CAPS_pubpropertyName

Gets or sets the name of this RibbonBase.

System_CAPS_pubpropertyOfficeMenu

Gets a RibbonOfficeMenu that represents the Microsoft Office Menu customization.

System_CAPS_pubpropertyParent

Gets a RibbonComponent that represents the parent of the RibbonComponent of this RibbonBase.

System_CAPS_pubpropertyRibbonId

Gets the Ribbon ID that was used to create this instance of the RibbonBase class.

System_CAPS_pubpropertyRibbonType

Gets a comma-separated list of Ribbon IDs that are associated with this RibbonBase instance.

System_CAPS_pubpropertyRibbonUI

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code.

System_CAPS_pubpropertySite

(Inherited from Component.)

System_CAPS_pubpropertyStartFromScratch

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.

System_CAPS_pubpropertyTabs

Gets a collection of RibbonTab objects in the RibbonOfficeMenu.

System_CAPS_pubpropertyTag

Gets or sets application-specific data that is associated with this RibbonBase.

NameDescription
System_CAPS_pubmethodCreateObjRef(Type)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

(Inherited from Component.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the RibbonBase class and optionally releases the managed resources. (Overrides Component.Dispose(Boolean).)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Component.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_protmethodGetService(Type)

(Inherited from Component.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodPerformDynamicLayout()

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.

System_CAPS_pubmethodPerformLayout()

Refreshes the Ribbon user interface.

System_CAPS_pubmethodResumeLayout()

Reverses the effect of the SuspendLayout method.

System_CAPS_pubmethodResumeLayout(Boolean)

Reverses the effect of the SuspendLayout method.

System_CAPS_pubmethodSuspendLayout()

Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon.

System_CAPS_pubmethodToString()

(Inherited from Component.)

NameDescription
System_CAPS_pubeventClose

Occurs when this RibbonBase instance is closing.

System_CAPS_pubeventDisposed

(Inherited from Component.)

System_CAPS_pubeventLoad

Occurs when the RibbonBase is loaded into the Microsoft Office application.

System_CAPS_pubeventLoadImage

Occurs 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 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.

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

Return to top
Show: