Microsoft.Office.Tools.Ribbon Namespace

  • Article

The Microsoft.Office.Tools.Ribbon namespace contains components, controls, and supporting collections, classes, and enumerations that enable you to customize the Ribbon in the user interface (UI) of several Microsoft Office applications.

All of the controls in the Microsoft.Office.Tools.Ribbon namespace can be added to your Office customization by dragging them from the Office Ribbon Controls tab of the ToolBox onto the Ribbon Designer. In addition, the RibbonMenu control enables you to add the following controls at run time:

To add these controls to a RibbonMenu at run time, you must set the Dynamic property of the menu to true at design time.

When you create a control at run time to add to a menu, you can change any properties of the newly created control before you add it to the menu. After you add a control to a menu, some of its properties become read-only. For more information, see Ribbon Object Model Overview.

You can use other properties to control the appearance and behavior of your controls at run time. For example, you can implement run-time changes to the user interface by using the Enabled and Visible properties to enable, disable, show, and hide controls that were added at design time.

Classes

  Class Description
Public class RibbonBase Serves as the base class for Microsoft Office Ribbon customizations.
Public class RibbonCollectionBase Provides access to the IRibbonExtension objects in a Ribbon customization.

Interfaces

  Interface Description
Public interface IRibbonExtension Represents an extension of a OfficeRibbon object.
Public interface OfficeRibbon Represents a Microsoft Office Ribbon customization that is created by using the Ribbon Designer in an Office project in Visual Studio.
Public interface RibbonBox Arranges and aligns controls on a custom Ribbon.
Public interface RibbonButton Represents a button on a custom Ribbon.
Public interface RibbonButtonGroup Represents a group of button controls on a Ribbon.
Public interface RibbonCheckBox Represents a check box control on a Ribbon.
Public interface RibbonComboBox Represents a combo box on a custom Ribbon.
Public interface RibbonComponent Contains methods and members that enable communication with Visual Studio, navigation through the control hierarchy in your application, and optimization of the run time layout of controls.
Public interface RibbonControl Provides properties used by controls in a Microsoft Office customization.
Public interface RibbonControlEventArgs Provides data for a variety of events that are raised in a Microsoft Office customization.
Public interface RibbonControlId Encapsulates an identification string that Microsoft Office uses to refer to controls.
Public interface RibbonDialogLauncher Represents a small standardized icon on a group that can be used to open a dialog box.
Public interface RibbonDropDown Represents a list of items that a user can choose from and a list of Ribbon buttons that a user can click.
Public interface RibbonDropDownItem Represents an item in a drop-down list in a Ribbon drop-down.
Public interface RibbonEditBox Represents an edit box on a Ribbon.
Public interface RibbonFactory Provides methods that you can use to create Ribbon controls for a Microsoft Office Ribbon customization.
Public interface RibbonGallery Represents a control that displays a menu of RibbonDropDownItem objects and RibbonButton controls.
Public interface RibbonGroup Represents a group of controls on a Ribbon tab.
Public interface RibbonLabel Represents a label on a RibbonGroup or RibbonBox.
Public interface RibbonLoadImageEventArgs Provides data for the LoadImage event.
Public interface RibbonManager Manages the Ribbon customizations that are created by using the Ribbon Designer in an Office project.
Public interface RibbonMenu Represents a menu on a Ribbon tab or on the Microsoft Office Menu.
Public interface RibbonOfficeMenu Provides access to controls that you add to the Microsoft Office Menu.
Public interface RibbonPosition Represents the location of a Ribbon control on the Microsoft Office Menu relative to a built-in control, the location of a tab relative to a built-in tab, or the location of a group relative to a built-in group.
Public interface RibbonPositionStatics Provides methods that enable you to specify the position of a control, group, or tab in a Ribbon customization.
Public interface RibbonReadOnlyCollection Provides access to the IRibbonExtension objects in a Ribbon customization.
Public interface RibbonSeparator Represents a separator control for a group or menu on the Ribbon.
Public interface RibbonSplitButton A Ribbon control that combines a button or a toggle button and a drop-down menu.
Public interface RibbonTab Contains one or more groups of controls on the Ribbon.
Public interface RibbonToggleButton Represents a toggle button control on a Ribbon.
Public interface RibbonUIEventArgs Provides data for events that are raised in the Ribbon.

Delegates

  Delegate Description
Public delegate RibbonControlEventHandler Represents the method that will handle events of an RibbonControl.
Public delegate RibbonLoadImageEventHandler Represents the method that will handle the LoadImage event of an OfficeRibbon.
Public delegate RibbonUIEventHandler Represents the method that will handle the Load event of an OfficeRibbon.

Enumerations

  Enumeration Description
Public enumeration RibbonBoxStyle Specifies whether controls are aligned vertically or horizontally on a RibbonBox.
Public enumeration RibbonButtonType Specifies the type of button that a RibbonSplitButton displays.
Public enumeration RibbonControlIdType Contains values that determine whether a RibbonControlId identifies a Microsoft Office control or a custom control.
Public enumeration RibbonPositionType Specifies the position of a control on the Microsoft Office Menu, a group of controls on a built-in tab, or a tab among built-in or custom tabs.

See Also

Reference

Other Resources

Ribbon Object Model Overview

Ribbon Overview