RibbonComponent Interface

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)

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

Top

Methods

  Name Description
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method 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.
Public method PerformLayout Calls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended.
Public method ResumeLayout() Reverses the effect of the SuspendLayout method.
Public method ResumeLayout(Boolean) Reverses the effect of the SuspendLayout method.
Public method SuspendLayout Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon.

Top

Events

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

See Also

Reference

Microsoft.Office.Tools.Ribbon Namespace