RibbonDropDownItem Interface

Definition

Namespace:

Microsoft.Office.Tools.Ribbon

Assembly:

Microsoft.Office.Tools.Common.dll

Represents an item in a drop-down list in a Ribbon drop-down.

public interface class RibbonDropDownItem

[System.Runtime.InteropServices.Guid("e715f92b-e5a0-434e-b8d2-9c43f4a6c0c2")]
public interface RibbonDropDownItem

[<System.Runtime.InteropServices.Guid("e715f92b-e5a0-434e-b8d2-9c43f4a6c0c2")>]
type RibbonDropDownItem = interface

Public Interface RibbonDropDownItem

Attributes

GuidAttribute

Remarks

A RibbonDropDownItem object contains all the data necessary to visually represent an item in a list in a RibbonComboBox, RibbonDropDown, or RibbonGallery. RibbonDropDownItem items have a label and, optionally, an associated image. They can also have a Screen Tip and Enhanced Screen Tip, which are both descriptions that appear when the user pauses the mouse pointer over a control.

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

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

Properties

Id	Gets a unique string that Microsoft Office uses to identify this RibbonDropDownItem.
Image	Gets or sets an image this is displayed on this RibbonDropDownItem.
Label	Gets or sets the text that is displayed by this RibbonDropDownItem.
OfficeImageId	Gets or sets the image to display on the RibbonDropDownItem, if you want to use a built-in Microsoft Office icon.
Parent	Gets the RibbonComponent to which this RibbonDropDownItem belongs.
Ribbon	Gets the top-level Ribbon object that contains the rest of the control hierarchy.
ScreenTip	Gets or sets tip text that appears when the user moves the pointer over the RibbonDropDownItem.
SuperTip	Gets or sets multiline tip text that appears when the user moves the pointer over the RibbonDropDownItem.
Tag	Gets or sets application-specific data that is associated with this RibbonDropDownItem.