RibbonControl Interface

Article
02/06/2013

Provides properties used by controls in a Microsoft Office customization.

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

Syntax

'Declaration
<GuidAttribute("19509b89-9091-4063-a495-f688299c8c3a")> _
Public Interface RibbonControl _
    Inherits RibbonComponent, IComponent, IDisposable

[GuidAttribute("19509b89-9091-4063-a495-f688299c8c3a")]
public interface RibbonControl : RibbonComponent, 
    IComponent, IDisposable

The RibbonControl type exposes the following members.

Properties

	Name	Description
	Enabled	Gets or sets a value that indicates whether this RibbonControl is enabled.
	Id	Gets a string that Microsoft Office uses to identify this RibbonControl object.
	Name	Gets or sets the name of this RibbonComponent. (Inherited from RibbonComponent.)
	Parent	Gets a RibbonComponent that represents the parent of this RibbonComponent. (Inherited from RibbonComponent.)
	Ribbon	Gets the top-level Ribbon object that contains the control hierarchy. (Inherited from RibbonComponent.)
	RibbonUI	Infrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code. (Inherited from RibbonComponent.)
	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. (Inherited from RibbonComponent.)
	Visible	Gets or sets a value that indicates whether this RibbonControl is visible.

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. (Inherited from RibbonComponent.)
	PerformLayout	Calls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended. (Inherited from RibbonComponent.)
	ResumeLayout()	Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)
	ResumeLayout(Boolean)	Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)
	SuspendLayout	Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon. (Inherited from RibbonComponent.)

Top

Events

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

Top

Remarks

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