Export (0) Print
Expand All

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)

[GuidAttribute("5d8ffee9-0105-497d-af15-6dcc5cc78310")]
public interface RibbonGroup : RibbonComponent, 
	IComponent, IDisposable

The RibbonGroup type exposes the following members.

  NameDescription
Public propertyDialogLauncherGets or sets the Ribbon dialog launcher that is associated with the group.
Public propertyIdGets a string that identifies the current group.
Public propertyItemsGets the controls in the group.
Public propertyKeyTipGets or sets the keyboard shortcut of the group.
Public propertyLabelGets or sets the text that is displayed by the label of the group.
Public propertyNameGets or sets the name of this RibbonComponent. (Inherited from RibbonComponent.)
Public propertyParentGets a RibbonComponent that represents the parent of this RibbonComponent. (Inherited from RibbonComponent.)
Public propertyPositionGets or sets the position of a group on a built-in tab, relative to a built-in group on the tab.
Public propertyRibbonGets the top-level Ribbon object that contains the control hierarchy. (Inherited from RibbonComponent.)
Public propertyRibbonUIInfrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code. (Inherited from RibbonComponent.)
Public propertySiteGets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public propertyTagGets or sets application-specific data that is associated with this RibbonComponent. (Inherited from RibbonComponent.)
Public propertyVisibleGets or sets a value that indicates whether the group is visible.
Top

  NameDescription
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public methodPerformDynamicLayoutCalls 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 methodPerformLayoutCalls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended. (Inherited from RibbonComponent.)
Public methodResumeLayout()Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)
Public methodResumeLayout(Boolean)Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)
Public methodSuspendLayoutPrevents the Microsoft Office application from refreshing the state of controls on the Ribbon. (Inherited from RibbonComponent.)
Top

  NameDescription
Public eventDialogLauncherClickOccurs when the user clicks the Ribbon dialog launcher icon in the group.
Public eventDisposedRepresents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Top

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.

NoteNote

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: http://go.microsoft.com/fwlink/?LinkId=160658.

Show:
© 2014 Microsoft