RibbonComponent Interface

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Contains methods and members that enable communication with Visual Studio, navigation through the control hierarchy in your application, and optimization of the run time layout of controls.

Namespace:  Microsoft.Office.Tools.Ribbon
Assemblies:   Microsoft.Office.Tools.Excel.v4.0.Utilities (in Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)
  Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)
  Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)
  Microsoft.Office.Tools.Common.v4.0.Utilities (in Microsoft.Office.Tools.Common.v4.0.Utilities.dll)

[GuidAttribute("09b06894-74de-44ff-9d48-9661ae639f41")]
public interface RibbonComponent : IComponent, 
	IDisposable

The RibbonComponent type exposes the following members.

  NameDescription
Public propertyNameGets or sets the name of this RibbonComponent.
Public propertyParentGets a RibbonComponent that represents the parent of this RibbonComponent.
Public propertyRibbonGets the top-level Ribbon object that contains the control hierarchy.
Public propertyRibbonUIInfrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code.
Public propertySiteGets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public propertyTagGets or sets application-specific data that is associated with this 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.
Public methodPerformLayoutCalls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended.
Public methodResumeLayout()Reverses the effect of the SuspendLayout method.
Public methodResumeLayout(Boolean)Reverses the effect of the SuspendLayout method.
Public methodSuspendLayoutPrevents the Microsoft Office application from refreshing the state of controls on the Ribbon.
Top

  NameDescription
Public eventDisposedRepresents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Top

Some members of this interface can be set only before the Ribbon is loaded into the Office application or before the control is added to a dynamic menu at run time. For information about setting these properties, see Ribbon Object Model Overview.

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 and the .NET Framework 4.5. 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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft