RibbonControl Interface

Reference

Definition

Namespace:: Microsoft.Office.Tools.Ribbon

Assemblies:: Microsoft.Office.Tools.Common.dll, Microsoft.Office.Tools.Common.v4.0.Utilities.dll, Microsoft.Office.Tools.Excel.v4.0.Utilities.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides properties used by controls in a Microsoft Office customization.

public interface class RibbonControl : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonComponent, System::ComponentModel::IComponent

[System.Runtime.InteropServices.Guid("19509b89-9091-4063-a495-f688299c8c3a")]
public interface RibbonControl : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonComponent, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("19509b89-9091-4063-a495-f688299c8c3a")>]
type RibbonControl = interface
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonControl
Implements IComponent, IDisposable, RibbonComponent

Derived: Microsoft.Office.Tools.Ribbon.RibbonBox

Microsoft.Office.Tools.Ribbon.RibbonButton

Microsoft.Office.Tools.Ribbon.RibbonButtonGroup

Microsoft.Office.Tools.Ribbon.RibbonCheckBox

Microsoft.Office.Tools.Ribbon.RibbonComboBox

More…

Attributes: GuidAttribute

Implements: RibbonComponent IComponent IDisposable

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

Properties

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	Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code. (Inherited from RibbonComponent)
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.

Methods

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)

Applies to

Share via