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

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

NameDescription
System_CAPS_pubpropertyName

Gets or sets the name of this RibbonComponent.

System_CAPS_pubpropertyParent

Gets a RibbonComponent that represents the parent of this RibbonComponent.

System_CAPS_pubpropertyRibbon

Gets the top-level Ribbon object that contains the control hierarchy.

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 IComponent.)

System_CAPS_pubpropertyTag

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

NameDescription
System_CAPS_pubmethodDispose()

(Inherited from IDisposable.)

System_CAPS_pubmethodPerformDynamicLayout()

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.

System_CAPS_pubmethodPerformLayout()

Calls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended.

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.

NameDescription
System_CAPS_pubeventDisposed

(Inherited from IComponent.)

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.

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

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 or later. 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.

Return to top
Show: