Export (0) Print
Expand All

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

The RibbonDropDown type exposes the following members.

  NameDescription
Public propertyButtonsGets a collection of RibbonButton objects that belong to this RibbonDropDown.
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 an image this is displayed on this RibbonDropDown.
Public propertyImageNameGets or sets the name that you can use in the LoadImage event handler to identify an image for the control.
Public propertyItemsGets a collection of the items in this RibbonDropDown.
Public propertyKeyTipGets or sets the keyboard shortcut for this RibbonDropDown.
Public propertyLabelGets or sets the text that appears on this RibbonDropDown.
Public propertyNameGets or sets the name of this RibbonComponent. (Inherited from RibbonComponent.)
Public propertyOfficeImageIdGets or sets the image to display on the RibbonDropDown, 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 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 propertyScreenTipGets or sets tip text that appears when the user moves the pointer over the RibbonDropDown.
Public propertySelectedItemGets or sets the RibbonDropDownItem that is currently selected.
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 RibbonDropDown is visible.
Public propertyShowItemImageGets or sets a value that indicates whether images are displayed for the items in the drop-down menu.
Public propertyShowItemLabelGets or sets a value that indicates whether labels are displayed for the items in the drop-down menu.
Public propertyShowLabelGets or sets a value that indicates whether the label for this RibbonDropDown is visible.
Public propertySiteGets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public propertySizeStringGets or sets a string that determines the size of the RibbonDropDown.
Public propertySuperTipGets or sets multiline tip text that appears when the user moves the pointer over the RibbonDropDown.
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 a RibbonDropDown.
Public eventDisposedRepresents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public eventItemsLoadingOccurs when controls are loaded into the RibbonDropDown.
Public eventSelectionChangedOccurs when a user selects a new item on a Ribbon drop-down control.
Top

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.

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

Community Additions

ADD
Show:
© 2014 Microsoft