Partager via


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)

Syntax

'Declaration
<GuidAttribute("dbee9dd2-d9b1-4d37-bb31-099fd6d64a68")> _
Public Interface RibbonDropDown _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable
[GuidAttribute("dbee9dd2-d9b1-4d37-bb31-099fd6d64a68")]
public interface RibbonDropDown : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

The RibbonDropDown type exposes the following members.

Properties

  Name Description
Public property Buttons Gets a collection of RibbonButton objects that belong to this RibbonDropDown.
Public property Enabled Gets or sets a value that indicates whether this RibbonControl is enabled. (Inherited from RibbonControl.)
Public property Id Gets a string that Microsoft Office uses to identify this RibbonControl object. (Inherited from RibbonControl.)
Public property Image Gets or sets an image this is displayed on this RibbonDropDown.
Public property ImageName Gets or sets the name that you can use in the LoadImage event handler to identify an image for the control.
Public property Items Gets a collection of the items in this RibbonDropDown.
Public property KeyTip Gets or sets the keyboard shortcut for this RibbonDropDown.
Public property Label Gets or sets the text that appears on this RibbonDropDown.
Public property Name Gets or sets the name of this RibbonComponent. (Inherited from RibbonComponent.)
Public property OfficeImageId Gets or sets the image to display on the RibbonDropDown, if you want to use a built-in Microsoft Office icon.
Public property Parent Gets a RibbonComponent that represents the parent of this RibbonComponent. (Inherited from RibbonComponent.)
Public property Ribbon Gets the top-level Ribbon object that contains the control hierarchy. (Inherited from RibbonComponent.)
Public property RibbonUI Infrastructure. Gets the IRibbonUI instance that is provided by the Microsoft Office application to the Ribbon extensibility code. (Inherited from RibbonComponent.)
Public property ScreenTip Gets or sets tip text that appears when the user moves the pointer over the RibbonDropDown.
Public property SelectedItem Gets or sets the RibbonDropDownItem that is currently selected.
Public property SelectedItemIndex Gets or sets the index of the currently selected RibbonDropDownItem.
Public property ShowImage Gets or sets a value that indicates whether the image that is associated with the RibbonDropDown is visible.
Public property ShowItemImage Gets or sets a value that indicates whether images are displayed for the items in the drop-down menu.
Public property ShowItemLabel Gets or sets a value that indicates whether labels are displayed for the items in the drop-down menu.
Public property ShowLabel Gets or sets a value that indicates whether the label for this RibbonDropDown is visible.
Public property Site Gets or sets the ISite associated with the IComponent. (Inherited from IComponent.)
Public property SizeString Gets or sets a string that determines the size of the RibbonDropDown.
Public property SuperTip Gets or sets multiline tip text that appears when the user moves the pointer over the RibbonDropDown.
Public property Tag Gets or sets application-specific data that is associated with this RibbonComponent. (Inherited from RibbonComponent.)
Public property Visible Gets or sets a value that indicates whether this RibbonControl is visible. (Inherited from RibbonControl.)

Top

Methods

  Name Description
Public method Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
Public method PerformDynamicLayout 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.)
Public method PerformLayout Calls Microsoft.Office.Core.IRibbonUI.InvalidateControl if the RibbonComponent has a parent and layout is not suspended. (Inherited from RibbonComponent.)
Public method ResumeLayout() Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)
Public method ResumeLayout(Boolean) Reverses the effect of the SuspendLayout method. (Inherited from RibbonComponent.)
Public method SuspendLayout Prevents the Microsoft Office application from refreshing the state of controls on the Ribbon. (Inherited from RibbonComponent.)

Top

Events

  Name Description
Public event ButtonClick Occurs when a user clicks a button on a RibbonDropDown.
Public event Disposed Represents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public event ItemsLoading Occurs when controls are loaded into the RibbonDropDown.
Public event SelectionChanged Occurs when a user selects a new item on a Ribbon drop-down control.

Top

Remarks

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.

Note

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: https://go.microsoft.com/fwlink/?LinkId=160658.

See Also

Reference

Microsoft.Office.Tools.Ribbon Namespace

RibbonDropDown.Items

RibbonDropDown.Buttons

Other Resources

Ribbon Overview

Ribbon Designer

Ribbon Object Model Overview

How to: Get Started Customizing the Ribbon