RibbonDropDown Interface

 

Represents a list of items that a user can choose from and a list of Ribbon buttons that a user can click.

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

[GuidAttribute("dbee9dd2-d9b1-4d37-bb31-099fd6d64a68")]
public interface RibbonDropDown : RibbonControl, RibbonComponent, 
	IComponent, IDisposable

NameDescription
System_CAPS_pubpropertyButtons

Gets a collection of RibbonButton objects that belong to this RibbonDropDown.

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 an image this is displayed on this RibbonDropDown.

System_CAPS_pubpropertyImageName

Gets or sets the name that you can use in the LoadImage event handler to identify an image for the control.

System_CAPS_pubpropertyItems

Gets a collection of the items in this RibbonDropDown.

System_CAPS_pubpropertyKeyTip

Gets or sets the keyboard shortcut for this RibbonDropDown.

System_CAPS_pubpropertyLabel

Gets or sets the text that appears on this RibbonDropDown.

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 RibbonDropDown, 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_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_pubpropertyScreenTip

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

System_CAPS_pubpropertySelectedItem

Gets or sets the RibbonDropDownItem that is currently selected.

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 RibbonDropDown is visible.

System_CAPS_pubpropertyShowItemImage

Gets or sets a value that indicates whether images are displayed for the items in the drop-down menu.

System_CAPS_pubpropertyShowItemLabel

Gets or sets a value that indicates whether labels are displayed for the items in the drop-down menu.

System_CAPS_pubpropertyShowLabel

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

System_CAPS_pubpropertySite

(Inherited from IComponent.)

System_CAPS_pubpropertySizeString

Gets or sets a string that determines the size of the RibbonDropDown.

System_CAPS_pubpropertySuperTip

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

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

System_CAPS_pubeventDisposed

(Inherited from IComponent.)

System_CAPS_pubeventItemsLoading

Occurs when controls are loaded into the RibbonDropDown.

System_CAPS_pubeventSelectionChanged

Occurs when a user selects a new item on a Ribbon drop-down control.

A RibbonDropDown can contain RibbonDropDownItem objects and RibbonButton controls.

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

You cannot add buttons to the Buttons collection at run time after the Ribbon has been loaded into Office.

The procedures below explain how to add RibbonDropDownItem objects and RibbonButton controls to a RibbonDropDown.

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

Some members of this type can be set only before the Ribbon is loaded into the Office application. 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: