RibbonGallery Interface

Represents a control that displays a menu of RibbonDropDownItem objects and RibbonButton controls.

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

Syntax

'Declaration
<GuidAttribute("c1cff037-81e7-44a0-8f9d-150237dfd312")> _
Public Interface RibbonGallery _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("c1cff037-81e7-44a0-8f9d-150237dfd312")]
public interface RibbonGallery : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

The RibbonGallery type exposes the following members.

Properties

	Name	Description
	Buttons	Gets the collection of buttons on this RibbonGallery.
	ColumnCount	Gets or sets the number of Item columns in this RibbonGallery.
	ControlSize	Gets or sets the size of the RibbonGallery control.
	Description	Gets or sets the text that appears on this RibbonGallery control on a menu or split button.
	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.)
	Image	Gets or sets the image that is displayed on the button.
	ImageName	Gets or sets the name that you can use to identify the RibbonGallery in the LoadImage event handler.
	ItemImageSize	Gets or sets a Size that gives the dimensions of the images that are displayed by the items in this RibbonGallery.
	Items	Gets a collection of the RibbonDropDownItem components in this RibbonGallery.
	KeyTip	Gets or sets the keyboard shortcut for this RibbonGallery.
	Label	Gets or sets the text that appears on this RibbonGallery.
	Name	Gets or sets the name of this RibbonComponent. (Inherited from RibbonComponent.)
	OfficeImageId	Gets or sets the image to display on the control, if you want to use a built-in Microsoft Office icon.
	Parent	Gets a RibbonComponent that represents the parent of this RibbonComponent. (Inherited from RibbonComponent.)
	Position	Gets or sets the position of the gallery, if the gallery is on the Microsoft Office Menu.
	Ribbon	Gets the top-level Ribbon object that contains the control hierarchy. (Inherited from RibbonComponent.)
	RibbonUI	Infrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code. (Inherited from RibbonComponent.)
	RowCount	Gets or sets the number of rows of RibbonDropDownItem components that this RibbonGallery displays.
	ScreenTip	Gets or sets tip text that appears when the user moves the pointer over this RibbonGallery.
	SelectedItem	Gets or sets the currently selected item.
	SelectedItemIndex	Gets or sets the index of the currently selected RibbonDropDownItem.
	ShowImage	Gets or sets a value that indicates whether the image that is associated with the RibbonGallery is visible.
	ShowItemImage	Gets or sets a value that indicates whether images are displayed for the items in the gallery.
	ShowItemLabel	Gets or sets a value that indicates whether labels are shown for items on this RibbonGallery.
	ShowItemSelection	Gets or sets a value that indicates whether the currently selected RibbonDropDownItem is visually differentiated from the rest of the unselected items.
	ShowLabel	Gets or sets a value that indicates whether the label for this RibbonGallery is visible.
	Site	Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
	SuperTip	Gets or sets multiline tip text that appears when the user moves the pointer over the RibbonGallery.
	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.)

Top

Methods

	Name	Description
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
	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.)

Top

Events

	Name	Description
	ButtonClick	Occurs when a user clicks a button on this RibbonGallery.
	Click	Occurs when a user clicks an item on this RibbonGallery.
	Disposed	Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)
	ItemsLoading	Occurs when this RibbonGallery is opened.

Top

Remarks

Like the RibbonDropDown interface, RibbonGallery displays a menu of RibbonDropDownItem objects and RibbonButton controls.

Unlike the RibbonDropDown Interface, the RibbonGallery interface raises Click events, rather than SelectionChanged events, when a user clicks a RibbonDropDownItem. This means, for example, that the Click event is raised twice when a user clicks the same RibbonDropDownItem twice. (The SelectionChanged event would be raised at most once when the initial selection was made for the same scenario on a RibbonDropDown, depending on what the selection was before the first click.)

The ShowItemSelection property controls whether the currently selected RibbonDropDownItem is visually differentiated from the unselected items. Only one item at a time can be selected in a RibbonGallery.

The ItemImageSize property can be used to specify image sizes other than 16x16 and 32x32.

To add RibbonDropDownItem objects at design time

1. Click the Items property in the Properties window.

2. Click the ellipsis (...).

3. In the DropDown Collection Editor, add, order, and edit new items.

You can add RibbonButton controls to a RibbonGallery at design time.

To add RibbonButton controls at design time

1. Click the Buttons property in the Properties window.

2. Click the ellipsis (...).

3. In the Button Collection Editor, add, order, and edit new button controls.

You can create a RibbonGallery at run time by using the CreateRibbonGallery 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.

Some properties of this control can be set only before the Ribbon is loaded into the Office application or before the control is added to a dynamic menu at run time. For information about setting these properties, see Ribbon Object Model Overview.

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