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

NameDescription
System_CAPS_pubpropertyButtons

Gets the collection of buttons on this RibbonGallery.

System_CAPS_pubpropertyColumnCount

Gets or sets the number of Item columns in this RibbonGallery.

System_CAPS_pubpropertyControlSize

Gets or sets the size of the RibbonGallery control.

System_CAPS_pubpropertyDescription

Gets or sets the text that appears on this RibbonGallery control on a menu or split button.

System_CAPS_pubpropertyEnabled

Gets or sets a value that indicates whether this RibbonControl is enabled.(Inherited from RibbonControl.)

System_CAPS_pubpropertyId

Gets a string that Microsoft Office uses to identify this RibbonControl object.(Inherited from RibbonControl.)

System_CAPS_pubpropertyImage

Gets or sets the image that is displayed on the button.

System_CAPS_pubpropertyImageName

Gets or sets the name that you can use to identify the RibbonGallery in the LoadImage event handler.

System_CAPS_pubpropertyItemImageSize

Gets or sets a Size that gives the dimensions of the images that are displayed by the items in this RibbonGallery.

System_CAPS_pubpropertyItems

Gets a collection of the RibbonDropDownItem components in this RibbonGallery.

System_CAPS_pubpropertyKeyTip

Gets or sets the keyboard shortcut for this RibbonGallery.

System_CAPS_pubpropertyLabel

Gets or sets the text that appears on this RibbonGallery.

System_CAPS_pubpropertyName

Gets or sets the name of this RibbonComponent.(Inherited from RibbonComponent.)

System_CAPS_pubpropertyOfficeImageId

Gets or sets the image to display on the control, if you want to use a built-in Microsoft Office icon.

System_CAPS_pubpropertyParent

Gets a RibbonComponent that represents the parent of this RibbonComponent.(Inherited from RibbonComponent.)

System_CAPS_pubpropertyPosition

Gets or sets the position of the gallery, if the gallery is on the Microsoft Office Menu.

System_CAPS_pubpropertyRibbon

Gets the top-level Ribbon object that contains the control hierarchy.(Inherited from RibbonComponent.)

System_CAPS_pubpropertyRibbonUI

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code.(Inherited from RibbonComponent.)

System_CAPS_pubpropertyRowCount

Gets or sets the number of rows of RibbonDropDownItem components that this RibbonGallery displays.

System_CAPS_pubpropertyScreenTip

Gets or sets tip text that appears when the user moves the pointer over this RibbonGallery.

System_CAPS_pubpropertySelectedItem

Gets or sets the currently selected item.

System_CAPS_pubpropertySelectedItemIndex

Gets or sets the index of the currently selected RibbonDropDownItem.

System_CAPS_pubpropertyShowImage

Gets or sets a value that indicates whether the image that is associated with the RibbonGallery is visible.

System_CAPS_pubpropertyShowItemImage

Gets or sets a value that indicates whether images are displayed for the items in the gallery.

System_CAPS_pubpropertyShowItemLabel

Gets or sets a value that indicates whether labels are shown for items on this RibbonGallery.

System_CAPS_pubpropertyShowItemSelection

Gets or sets a value that indicates whether the currently selected RibbonDropDownItem is visually differentiated from the rest of the unselected items.

System_CAPS_pubpropertyShowLabel

Gets or sets a value that indicates whether the label for this RibbonGallery is visible.

System_CAPS_pubpropertySite

(Inherited from IComponent.)

System_CAPS_pubpropertySuperTip

Gets or sets multiline tip text that appears when the user moves the pointer over the RibbonGallery.

System_CAPS_pubpropertyTag

Gets or sets application-specific data that is associated with this RibbonComponent.(Inherited from RibbonComponent.)

System_CAPS_pubpropertyVisible

Gets or sets a value that indicates whether this RibbonControl is visible.(Inherited from RibbonControl.)

NameDescription
System_CAPS_pubmethodDispose()

(Inherited from IDisposable.)

System_CAPS_pubmethodPerformDynamicLayout()

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

System_CAPS_pubmethodPerformLayout()

Calls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended.(Inherited from RibbonComponent.)

System_CAPS_pubmethodResumeLayout()

Reverses the effect of the SuspendLayout method.(Inherited from RibbonComponent.)

System_CAPS_pubmethodResumeLayout(Boolean)

Reverses the effect of the SuspendLayout method.(Inherited from RibbonComponent.)

System_CAPS_pubmethodSuspendLayout()

Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon.(Inherited from RibbonComponent.)

NameDescription
System_CAPS_pubeventButtonClick

Occurs when a user clicks a button on this RibbonGallery.

System_CAPS_pubeventClick

Occurs when a user clicks an item on this RibbonGallery.

System_CAPS_pubeventDisposed

(Inherited from IComponent.)

System_CAPS_pubeventItemsLoading

Occurs when this RibbonGallery is opened.

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.

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

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.

Return to top
Show: