Back to Devexpress

DevExpress.XtraBars.Ribbon Namespace

windowsforms-devexpress-dot-xtrabars-15d650f4.md

latest18.9 KB
Original Source

DevExpress.XtraBars.Ribbon Namespace

Contains the main classes that support the RibbonControl’s infrastructure.

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Classes

NameDescription
ApplicationMenuA MS Office 2007-inspired main menu for Ribbon UI.
AppMenuFileLabelA label that imitates an item in the Recent Documents pane in MS Office 2007 UI. This is a custom-made control designed for the Ribbon Simple Pad demo, and is not included in the official WinForms Controls line-up. User discretion is advised. We recommend that you use the RecentItemControl instead.
BackstageViewButtonItemThis item acts as a button within a BackstageViewControl.
BackstageViewClientControlA container that displays the contents of a BackstageViewTabItem within a BackstageViewControl.
BackstageViewControlA main menu for Ribbon UI, inspired by the menus found in MS Office 2010-2016.
BackstageViewItemA base class for items within a BackstageViewControl.
BackstageViewItemBaseA base class for items within a BackstageViewControl.
BackstageViewItemEventArgsContains data for events that occur for a BackstageViewControl‘s items.
BackstageViewItemSeparatorA separator between items within a BackstageViewControl.
BackstageViewTabItemActs as a tab page within a BackstageViewControl.
ExpandCollapseMenuShowingEventArgsContains data for the ExpandCollapseMenuShowing event.
GalleryControlThe control displaying an image gallery, with the capability to categorize items into groups.
GalleryDropDownDisplays an image gallery and custom commands in a popup window.
GalleryFilterMenuClickEventArgsProvides data for events that fire when items are clicked within a gallery’s Filter Menu.
GalleryFilterMenuEventArgsProvides data for the events that fire when a Filter Menu is about to be displayed for a gallery.
GalleryItemRepresents an item within a gallery.
GalleryItemClickEventArgsProvides data for the BaseGallery.ItemClick event.
GalleryItemCollectionRepresents a collection of gallery items.
GalleryItemCustomDrawEventArgsProvides data for events used to custom paint gallery items.
GalleryItemEventArgsProvides data for gallery item handling events.
GalleryItemGroupRepresents a group of gallery items within a gallery.
GalleryItemGroupCollectionRepresents a collection of gallery groups.
ImageGalleryCustomDrawEventArgsContains data for the CustomDraw event.
ImageGalleryFilterMenuRepresents a filter menu for a GalleryControl.
RadialMenuThe menu where items are arranged along the circumference.
RecentButtonItemA simple button for the Recent Item Control.
RecentControlContainerItemA RecentItemControl‘s item that holds any custom content.
RecentHyperlinkItemAn hyperlink element within the RecentItemControl.
RecentItemBaseA base class for all UI elements in the RecentItemControl.
RecentItemControlThe control designed to build a complex content for BackstageViewTabItem objects.
RecentItemEventArgsProvides base data for RecentItemControl elements’ events.
RecentLabelItemA label item within the RecentItemControl.
RecentPanelBaseA base class for the RecentItemControl‘s panels (e.g., the RecentStackPanel objects).
RecentPinItemA pin item within the Recent Item Control.
RecentSeparatorItemA RecentItemControl element that visually delimits other elements.
RecentStackPanelA simple RecentItemControl panel that arranges elements in a single column.
RecentTabItemA tab element within the Recent Item Control.
RecentTextGlyphItemBaseThe base class for all RecentItemControl elements that are able to display both caption and image.
RibbonBarItemsRepresents a collection of bar items within the RibbonControl.
RibbonControlAllows you to create a Ribbon toolbar with commands grouped into categories, pages and page groups.
RibbonCustomizationFormOptionsRepresents options related to the Customization Form.
RibbonEmptyAreaImageOptionsContains options that specify a raster or vector image displayed in the ribbon’s empty area.
RibbonFormA form that integrates a RibbonControl.
RibbonMergeEventArgsContains data for the Merge, BeforeUnMerge, and UnMerge events.
RibbonMessageArgsContains Ribbon message-related settings.
RibbonMiniToolbarA popup toolbar whose transparency depends on the distance from the mouse cursor to it.
RibbonMiniToolbarCollectionA RibbonControl‘s collection of RibbonMiniToolbar objects
RibbonMiniToolbarOpacityOptionsProvides opacity options for a toolbar.
RibbonOptionsExpandCollapseMenuContains settings that specify the availability and behavior of the Ribbon Display Options popup menu.
RibbonOptionsSearchMenuContains properties related to the Search Menu.
RibbonOptionsTouchProvides access to a set of properties that manage this RibbonControl‘s touch behavior.
RibbonPageRepresents a Ribbon Page within a RibbonControl.
RibbonPageCategoryRepresents a Ribbon page category.
RibbonPageCategoryCollectionRepresents a collection of RibbonPageCategory objects.
RibbonPageCategoryOptionsStores settings applied to all categories owned by a parent Ribbon. To access these settings, use the RibbonControl.OptionsPageCategories property.
RibbonPageCollectionRepresents a collection of pages within the RibbonControl.
RibbonPageGroupRepresents a group within a Ribbon Page.
RibbonPageGroupCollectionRepresents a page group collection for Ribbon pages.
RibbonPageGroupEventArgsProvides data for the RibbonControl.PageGroupCaptionButtonClick and RibbonPageGroup.CaptionButtonClick events.
RibbonQuickAccessToolbarRepresents the Quick Access Toolbar.
RibbonSearchMenuBaseEventArgsContains data for events related to the Search Menu.
RibbonSearchMenuEnterPressedEventArgsContains data for the SearchMenuEnterPressed event.
RibbonSearchMenuEventArgsContains data for the CustomizeSearchMenu event.
RibbonStatusBarThe status bar designed to be used along with the RibbonControl.

Delegates

NameDescription
BackstageViewItemEventHandlerA method that will handle events that take BackstageViewItemEventArgs object as a parameter.
GalleryItemClickEventHandlerRepresents a method that will handle the BaseGallery.ItemClick event.
GalleryItemCustomDrawEventHandlerRepresents a method that will handle the BaseGallery.CustomDrawItemImage and BaseGallery.CustomDrawItemText events.
RibbonPageGroupEventHandlerRepresents a method that will handle the RibbonControl.PageGroupCaptionButtonClick and RibbonPageGroup.CaptionButtonClick events.

Enums

NameDescription
BackstageViewItemAlignmentEnumerates values that specify the vertical alignment of items in the Backstage View.
BackstageViewShowRibbonItemsProvides members that specify which RibbonControl‘s parts will be visible within an Office 2013-styled BackstageViewControl.
GalleryItemGroupCaptionAlignmentContains values that specify the horizontal alignment of a group caption content..
GallerySizeModeContains values that specify how a dropdown gallery can be resized.
ItemImageLocationContains values that specify how an image is displayed next to a text region.
RibbonControlColorSchemeEnumerates Ribbon paint schemes.
RibbonControlStyleEnumerates paint styles for a RibbonControl.
RibbonFormNavigationControlLayoutModeLists values that specify the alignment of the side navigation relative to the Ribbon Form’s title.
RibbonItemStylesLists the options that specify the bar item’s possible states within a Ribbon Control.
RibbonMdiMergeStyleContains values specifying when the merge mechanism is invoked in MDI applications when using Ribbon Controls within a parent and child MDI forms.
RibbonPageCategoryAlignmentEnumerates values that specify how custom page categories are aligned.
RibbonPageGroupItemsLayoutSpecifies how small items are arranged within a RibbonPageGroup in the Office2007, Office2010 and Office2013 Ribbon styles.
RibbonQuickAccessToolbarLocationLists the values that specify the location of a Quick Access Toolbar.
ShowPageHeadersModeLists values that specify when Ribbon page headers are displayed.
ShowPageKeyTipsModeLists modes that specify how to display key tips for ribbon pages.