Export (0) Print
Expand All

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)

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

The RibbonGallery type exposes the following members.

  NameDescription
Public propertyButtonsGets the collection of buttons on this RibbonGallery.
Public propertyColumnCountGets or sets the number of Item columns in this RibbonGallery.
Public propertyControlSizeGets or sets the size of the RibbonGallery control.
Public propertyDescriptionGets or sets the text that appears on this RibbonGallery control on a menu or split button.
Public propertyEnabledGets or sets a value that indicates whether this RibbonControl is enabled. (Inherited from RibbonControl.)
Public propertyIdGets a string that Microsoft Office uses to identify this RibbonControl object. (Inherited from RibbonControl.)
Public propertyImageGets or sets the image that is displayed on the button.
Public propertyImageNameGets or sets the name that you can use to identify the RibbonGallery in the LoadImage event handler.
Public propertyItemImageSizeGets or sets a Size that gives the dimensions of the images that are displayed by the items in this RibbonGallery.
Public propertyItemsGets a collection of the RibbonDropDownItem components in this RibbonGallery.
Public propertyKeyTipGets or sets the keyboard shortcut for this RibbonGallery.
Public propertyLabelGets or sets the text that appears on this RibbonGallery.
Public propertyNameGets or sets the name of this RibbonComponent. (Inherited from RibbonComponent.)
Public propertyOfficeImageIdGets or sets the image to display on the control, if you want to use a built-in Microsoft Office icon.
Public propertyParentGets a RibbonComponent that represents the parent of this RibbonComponent. (Inherited from RibbonComponent.)
Public propertyPositionGets or sets the position of the gallery, if the gallery is on the Microsoft Office Menu.
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 propertyRowCountGets or sets the number of rows of RibbonDropDownItem components that this RibbonGallery displays.
Public propertyScreenTipGets or sets tip text that appears when the user moves the pointer over this RibbonGallery.
Public propertySelectedItemGets or sets the currently selected item.
Public propertySelectedItemIndexGets or sets the index of the currently selected RibbonDropDownItem.
Public propertyShowImageGets or sets a value that indicates whether the image that is associated with the RibbonGallery is visible.
Public propertyShowItemImageGets or sets a value that indicates whether images are displayed for the items in the gallery.
Public propertyShowItemLabelGets or sets a value that indicates whether labels are shown for items on this RibbonGallery.
Public propertyShowItemSelectionGets or sets a value that indicates whether the currently selected RibbonDropDownItem is visually differentiated from the rest of the unselected items.
Public propertyShowLabelGets or sets a value that indicates whether the label for this RibbonGallery is visible.
Public propertySiteGets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public propertySuperTipGets or sets multiline tip text that appears when the user moves the pointer over the RibbonGallery.
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 this RibbonControl is visible. (Inherited from RibbonControl.)
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 eventButtonClickOccurs when a user clicks a button on this RibbonGallery.
Public eventClickOccurs when a user clicks an item on this RibbonGallery.
Public eventDisposedRepresents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public eventItemsLoadingOccurs when this RibbonGallery is opened.
Top

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.

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