Export (0) Print
Expand All

RibbonComboBox Interface

Represents a combo box on a custom Ribbon.

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

[GuidAttribute("97074be3-d4bb-4923-881a-7a6e225738af")]
public interface RibbonComboBox : RibbonControl, 
	RibbonComponent, IComponent, IDisposable

The RibbonComboBox type exposes the following members.

  NameDescription
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 RibbonComboBox.
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 RibbonComboBox.
Public propertyKeyTipGets or sets the keyboard shortcut for this RibbonComboBox.
Public propertyLabelGets or sets the text that appears on this RibbonComboBox.
Public propertyMaxLengthGets or sets a value that indicates the maximum number of characters allowed per entry in this RibbonComboBox.
Public propertyNameGets or sets the name of this RibbonComponent. (Inherited from RibbonComponent.)
Public propertyOfficeImageIdGets or sets the image to display on the RibbonComboBox, 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 RibbonComboBox.
Public propertyShowImageGets or sets a value that indicates whether the image that is associated with the RibbonComboBox is visible.
Public propertyShowItemImageGets or sets a value that indicates whether images are displayed for the items in the drop-down menu.
Public propertyShowLabelGets or sets a value that indicates whether the label for this RibbonComboBox 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 RibbonComboBox.
Public propertySuperTipGets or sets multiline tip text that appears when the user moves the pointer over the RibbonComboBox.
Public propertyTagGets or sets application-specific data that is associated with this RibbonComponent. (Inherited from RibbonComponent.)
Public propertyTextGets or sets the text that appears in this RibbonComboBox.
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 eventDisposedRepresents the method that handles the Disposed event of a component. (Inherited from IComponent.)
Public eventItemsLoadingOccurs when the drop-down list for this RibbonComboBox is opened.
Public eventTextChangedOccurs when a user changes the text in the RibbonComboBox.
Top

A combo box presents a user with a text entry field and a list of choices in a drop-down menu.

You can create a RibbonComboBox at run time by using the CreateRibbonComboBox 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 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 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: http://go.microsoft.com/fwlink/?LinkId=160658.

Show:
© 2014 Microsoft