Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

OfficeRibbon Interface

Represents a Microsoft Office Ribbon customization that is created by using the Ribbon Designer in an Office project in Visual Studio.

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

[GuidAttribute("49fbf223-6d24-4c4b-9101-2d5833434328")]
public interface OfficeRibbon : RibbonComponent, 
	IComponent, IDisposable

The OfficeRibbon type exposes the following members.

  NameDescription
Public propertyContextGets the Inspector window, or the Explorer window in Outlook, that is associated with this Ribbon.
Public propertyDefaultExtensionGets the default extension for this OfficeRibbon object.
Public propertyExtensionGets a custom extension for this OfficeRibbon object.
Public propertyGlobalGets or sets a value that determines whether this OfficeRibbon can be used in multiple contexts simultaneously.
Public propertyNameGets or sets the name of this RibbonComponent. (Inherited from RibbonComponent.)
Public propertyOfficeMenuGets a RibbonOfficeMenu that represents the Microsoft Office Menu customization.
Public propertyParentGets a RibbonComponent that represents the parent of this RibbonComponent. (Inherited from RibbonComponent.)
Public propertyRibbonGets the top-level Ribbon object that contains the control hierarchy. (Inherited from RibbonComponent.)
Public propertyRibbonIdGets the Ribbon ID that was used to create this instance of the OfficeRibbon object.
Public propertyRibbonTypeGets a comma-separated list of Ribbon IDs that are associated with this OfficeRibbon instance.
Public propertyRibbonUIInfrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code. (Inherited from RibbonComponent.)
Public propertySiteGets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
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 RibbonComponent. (Inherited from RibbonComponent.)
Top

  NameDescription
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public methodPerformDynamicLayoutCalls the Microsoft.Office.Core.IRibbonUI.InvalidateControl method of the parent control if the RibbonComponent has a dynamic parent, such as a dynamic menu, and layout is not suspended. (Inherited from RibbonComponent.)
Public methodPerformLayoutCalls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended. (Inherited from RibbonComponent.)
Public methodResumeLayout()Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)
Public methodResumeLayout(Boolean)Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)
Public methodSuspendLayoutPrevents the Microsoft Office application from refreshing the state of controls on the Ribbon. (Inherited from RibbonComponent.)
Top

  NameDescription
Public eventCloseOccurs when this OfficeRibbon instance is closing.
Public eventDisposedRepresents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public eventLoadOccurs when the OfficeRibbon is loaded into the Microsoft Office application.
Public eventLoadImageOccurs when the OfficeRibbon loads, if the ImageName property is set for one or more controls.
Top

You typically do not use the OfficeRibbon interface directly. Instead, use the Ribbon class that Visual Studio generates when you add a new Ribbon (Visual Designer) item to your project. You can accomplish most tasks related to the Ribbon by using events and properties in the generated Ribbon class.

The generated Ribbon class inherits from the RibbonBase class. This base class redirects all calls to its members to an internal implementation of the OfficeRibbon interface the Visual Studio Tools for Office runtime. If you want to work with the OfficeRibbon object directly, use the Base property of the generated Ribbon class.

NoteNote

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: http://go.microsoft.com/fwlink/?LinkId=160658.

Community Additions

ADD
Show:
© 2015 Microsoft