RibbonGroup Interface

Represents a group of controls on a Ribbon tab.

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

Syntax

'Declaration
<GuidAttribute("5d8ffee9-0105-497d-af15-6dcc5cc78310")> _
Public Interface RibbonGroup _
    Inherits RibbonComponent, IComponent, IDisposable
[GuidAttribute("5d8ffee9-0105-497d-af15-6dcc5cc78310")]
public interface RibbonGroup : RibbonComponent, 
    IComponent, IDisposable

The RibbonGroup type exposes the following members.

Properties

  Name Description
Public property DialogLauncher Gets or sets the Ribbon dialog launcher that is associated with the group.
Public property Id Gets a string that identifies the current group.
Public property Items Gets the controls in the group.
Public property KeyTip Gets or sets the keyboard shortcut of the group.
Public property Label Gets or sets the text that is displayed by the label of the group.
Public property Name Gets or sets the name of this RibbonComponent. (Inherited from RibbonComponent.)
Public property Parent Gets a RibbonComponent that represents the parent of this RibbonComponent. (Inherited from RibbonComponent.)
Public property Position Gets or sets the position of a group on a built-in tab, relative to a built-in group on the tab.
Public property Ribbon Gets the top-level Ribbon object that contains the control hierarchy. (Inherited from RibbonComponent.)
Public property RibbonUI Infrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code. (Inherited from RibbonComponent.)
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. (Inherited from RibbonComponent.)
Public property Visible Gets or sets a value that indicates whether the group is visible.

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

Top

Events

  Name Description
Public event DialogLauncherClick Occurs when the user clicks the Ribbon dialog launcher icon in the group.
Public event Disposed Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)

Top

Remarks

Visual Studio creates a RibbonGroup object when you drag a Group control from the Office Ribbon Controls tab of the Toolbox onto the Ribbon Designer.

Common Tasks

The following table lists members that are useful for common tasks. All of these tasks can be performed at design time. Some of these tasks can be performed at run time before the Ribbon is loaded. For more information, see Ribbon Object Model Overview.

Task

Member

Access the controls in the group, add controls to the group, or remove controls from the group.

Use the Items property.

Add a group to a Ribbon tab.

Add a RibbonGroup to the Groups collection of the tab.

Specify the location of a group on a built-in tab, relative to the location of a built-in group.

Use the Position property.

You can create a RibbonGroup at run time by using the CreateRibbonGroup 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 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

Other Resources

Ribbon Overview

Ribbon Designer

Ribbon Object Model Overview

How to: Get Started Customizing the Ribbon

How to: Customize a Built-in Tab