RibbonTab Interface

Definition

Namespace:

Microsoft.Office.Tools.Ribbon

Assemblies:

Microsoft.Office.Tools.Common.dll, Microsoft.Office.Tools.Common.v4.0.Utilities.dll

Contains one or more groups of controls on the Ribbon.

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

[System.Runtime.InteropServices.Guid("b2c81178-b119-41af-b358-46460ae005d9")]
public interface RibbonTab : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonComponent, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("b2c81178-b119-41af-b358-46460ae005d9")>]
type RibbonTab = interface
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonTab
Implements IComponent, IDisposable, RibbonComponent

Attributes

GuidAttribute

Implements

RibbonComponent IComponent IDisposable

Remarks

There is a hierarchy for adding Ribbon controls. Only a RibbonTab control can be used on a Microsoft.Office.Tools.Ribbon control. Only a RibbonGroup can be used on a RibbonTab control.

The Ribbon Designer supports custom and built-in tabs.

You can create a RibbonTab at run time by using the CreateRibbonTab method of the RibbonFactory object.

There are two ways to access the RibbonFactory object:

• By using the Factory property of the Ribbon class. Use this approach from code in your Ribbon class.

• By using the Globals.Factory.GetRibbonFactory method. Use this approach from code outside your Ribbon class.

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

ControlId	Gets or sets the unique name by which a Microsoft Office application refers to the tab.
Groups	Gets the collection of groups that are on the RibbonTab.
KeyTip	Gets or sets the keyboard shortcut for the tab.
Label	Gets or sets the text that appears on the tab.
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)
Position	Gets or sets the position of the tab on the Ribbon in relation to the built-in tabs.
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 the tab 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)