RibbonComponent Interface

Article
02/06/2013

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
Assembly: Microsoft.Office.Tools.Common (in Microsoft.Office.Tools.Common.dll)

Syntax

'Declaration
<GuidAttribute("09b06894-74de-44ff-9d48-9661ae639f41")> _
Public Interface RibbonComponent _
    Inherits IComponent, IDisposable

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

The RibbonComponent type exposes the following members.

Properties

	Name	Description
	Name	Gets or sets the name of this RibbonComponent.
	Parent	Gets a RibbonComponent that represents the parent of this RibbonComponent.
	Ribbon	Gets the top-level Ribbon object that contains the control hierarchy.
	RibbonUI	Infrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code.
	Site	Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
	Tag	Gets or sets application-specific data that is associated with this RibbonComponent.

Top

Methods

	Name	Description
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
	PerformDynamicLayout	Calls 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.
	PerformLayout	Calls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended.
	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.

Top

Events

	Name	Description
	Disposed	Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)

Top

Remarks

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.

Note

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: https://go.microsoft.com/fwlink/?LinkId=160658.

Share via