RibbonGallery Interface

Definition

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

[System.Runtime.InteropServices.Guid("c1cff037-81e7-44a0-8f9d-150237dfd312")]
public interface RibbonGallery : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("c1cff037-81e7-44a0-8f9d-150237dfd312")>]
type RibbonGallery = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonGallery
Implements IComponent, IDisposable, RibbonControl

Attributes

GuidAttribute

Implements

RibbonComponent RibbonControl IComponent IDisposable

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.

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

Methods

Events

Applies to