RibbonButtonGroup Interface

Reference

Definition

Namespace:: Microsoft.Office.Tools.Ribbon

Assembly:: Microsoft.Office.Tools.Common.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.

Represents a group of button controls on a Ribbon.

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

[System.Runtime.InteropServices.Guid("06e951b9-5334-4b3f-b058-8c16aa59ea94")]
public interface RibbonButtonGroup : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("06e951b9-5334-4b3f-b058-8c16aa59ea94")>]
type RibbonButtonGroup = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonButtonGroup
Implements IComponent, IDisposable, RibbonControl

Attributes: GuidAttribute

Implements: RibbonComponent RibbonControl IComponent IDisposable

Remarks

RibbonButtonGroup controls can contain buttons, toggle buttons, menus, split buttons, and galleries.

You can add a RibbonButtonGroup object to your Office customization at design time, or at run time before the Ribbon is loaded into the Microsoft Office application. For more information, see Ribbon Object Model Overview.

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

Enabled	Gets or sets a value that indicates whether this RibbonControl is enabled. (Inherited from RibbonControl)
Id	Gets a string that Microsoft Office uses to identify this RibbonControl object. (Inherited from RibbonControl)
Items	Gets the controls that are contained in this RibbonButtonGroup.
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. (Inherited from RibbonControl)

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