Back to Devexpress

DevExpress.XtraBars Namespace

windowsforms-devexpress-18ad3d25.md

latest23.6 KB
Original Source

DevExpress.XtraBars Namespace

The XtraBars namespace contains classes implementing the XtraBars’s functionality.

The classes derived from the BarItem class represent different types of toolbar items. The visual representation of each item within a toolbar or a menu is implemented via an appropriate item link class. For instance, the item link class representing the BarEditItem within a bar or menu, is implemented via the BarEditItemLink class, etc.

There are some classes representing the different collections used in the XtraBars. These collections are used to store bars and bar items within the BarManager, item links within the Bar, etc.

The enumerations (BarItemPaintStyle, BarItemBorderStyle, BarDockStyle, etc.) define the look and feel of toolbars and bar items created via the XtraBars Suite.

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Classes

NameDescription
BarRepresents a Windows-like toolbar.
BarAndDockingControllerAllows you to customize the form-scope display and behavior settings for controls and components included in the XtraBars library - bars, dock panels, Ribbon controls, App UI Manager (DocumentManager) and tabbed windows (XtraTabbedMdiManager).
BarAndDockingControllerLookAndFeelContains look and feel settings for the controls/components that are managed by a BarAndDockingController.
BarBaseButtonItemServes as a base class for classes that implement functionality for button items.
BarBaseButtonItemLinkRepresents a link to the BarBaseButtonItem item.
BarButtonGroupRepresents a group of links that correspond to the bar button items.
BarButtonGroupLinkRepresents a link to the BarButtonGroup item.
BarButtonItemA button command in the Ribbon UI, toolbar, or popup menu.
BarButtonItemLinkA bar item link to BarButtonItem.
BarCheckItemA bar item with toggle button functionality.
BarCheckItemImageOptionsContains options that specify images and image settings for BarCheckItem objects.
BarCheckItemLinkRepresents a link to the BarCheckItem.
BarCustomContainerItemProvides the functionality for all container items.
BarCustomContainerItemLinkRepresents a bar element that can contain links to other items.
BarCustomDrawEventArgsProvides data for the BarCustomContainerItem.PaintMenuBar and PopupMenu.PaintMenuBar event.
BarDockControlRepresents a Bar Dock Control.
BarDockingMenuItemDisplays commands to manipulate documents that are created by the DocumentManager.
BarDockingMenuItemLinkDisplays a BarDockingMenuItem within a bar or a menu.
BarDockWindowObsolete. Represents a dock window.
BarDockWindowCollectionRepresents the collection of BarDockWindow objects.
BarEditItemA bar item that contains an editor.
BarEditItemLinkRepresents the BarEditItem within a bar or a menu.
BarHeaderItemDisplays static text using a heading style which is determined by the current skin. The text is typically painted bold against a background that is different from the background of regular buttons. Use BarHeaderItem to add headers to a PopupMenu or BarSubItem (sub-menu) to separate sets of items.
BarHeaderItemLinkA link to the BarHeaderItem object.
BarItemProvides the functionality of bar elements.
BarItemCustomDrawEventArgsProvides data for the BarManager.CustomDrawItem event.
BarItemImageOptionsProvides options to specify images and image settings for bar items.
BarItemLinkSpecifies a bar element.
BarItemLinkCollectionA collection of bar item links.
BarItemLinkReadOnlyCollectionA read-only bar item link collection.
BarItemsRepresents a collection of existing items for a specific BarManager.
BarLargeButtonItemA bar item that displays a large image in a toolbar.
BarLargeButtonItemLinkRepresents a link to a large button item.
BarLinkContainerItemRepresents a link container.
BarLinkContainerItemLinkRepresents a bar element with a submenu contaning links.
BarListItemA bar item containing a list of items.
BarListItemLinkRepresents a BarListItem within a bar or a menu.
BarManagerThe component that manages traditional bars and popup menus.
BarManagerAppearancesContains default style settings for bars and their elements.
BarManagerCategoryAn individual category.
BarManagerCategoryCollectionA category collection in the BarManager.
BarManagerMergeEventArgsProvides data for the BarManager.Merge and BarManager.UnMerge events.
BarManagerPropertiesContains default customization settings for bars.
BarMdiChildrenListItemRepresents a bar item containing a list of active windows in an MDI applications.
BarMdiChildrenListItemLinkRepresents a BarMdiChildrenListItem within a bar or a menu.
BarOptionsProvides customization options for a bar.
BarsRepresents the bars collection.
BarShortcutContains item shortcut settings.
BarStaticItemRepresents a bar item with a look and feel similar to the StatusbarPanel.
BarStaticItemLinkRepresents the BarStaticItem within a bar or a menu.
BarSubItemA sub-menu that contains other bar items (including child sub-menus).
BarSubItemLinkRepresents the BarSubItemLink link within a bar or a menu.
BarToggleSwitchItemA bar item with toggle switch functionality.
BarToggleSwitchItemLinkA link to the BarToggleSwitchItem object.
BarToolbarsListItemA bar item that represents a check list of bars owned by a Bar Manager, and dock panels owned by a dock manager.
BarToolbarsListItemLinkRepresents a link to the BarToolbarsListItem.
BaseBarManagerOptionsThe base class for classes that store bar options.
CreateCustomizationFormEventArgsProvides data for the BarManager.CreateCustomizationForm event.
CreateToolbarEventArgsProvides data for the BarManager.CreateToolbar event of the BarManager component.
DefaultBarAndDockingControllerAllows you to customize the application-scope display and behavior settings for controls and components included in the XtraBars library - bars, dock panels, Ribbon controls, App UI Manager (DocumentManager) and tabbed windows (XtraTabbedMdiManager).
FormAssistantConverts a regular form to a DevExpress form and backwards.
HighlightedLinkChangedEventArgsProvides data for the BarManager.HighlightedLinkChanged event.
ItemCancelEventArgsProvides data for the BarEditItem.ShowingEditor event.
ItemClickEventArgsProvides data for the BarItem.ItemClick and BarManager.ItemClick events.
LinkEventArgsProvides data for events that require a link as the parameter.
ListItemClickEventArgsProvides data for the BarListItem.ListItemClick event.
MenuAppearanceContains style settings used to customize items within popup menus and container items.
PopupControlContainerThe control container that can be displayed as a dropdown.
PopupMenuA popup menu managed by a BarManager or RibbonControl. It can be used in controls (such as GridControl, TreeList, etc.) as a custom popup menu.
PopupMenuBaseThe base class for popup menus.
QueryShowPopupMenuEventArgsProvides data for the BarManager.QueryShowPopupMenu event of the BarManager component.
RibbonAppearancesProvides the appearance settings used to paint a Ribbon Control.
RibbonGalleryAppearancesProvides appearance settings that are used to paint Ribbon gallery elements.
RibbonGalleryBarItemA bar item that represents an In-Ribbon gallery.
RibbonGalleryBarItemLinkRepresents a link to a RibbonGalleryBarItem object.
RibbonPropertiesContains settings that control the display of bar items in a RibbonControl.
ShortcutItemClickEventArgsProvides data for the BarManager.ShortcutItemClick event.
ShowToolbarsContextMenuEventArgsProvides data for the BarManager.ShowToolbarsContextMenu event.
StandaloneBarDockControlThe control that can accommodate bars and display them at any position within the form.
StateAppearancesProvides a set of properties that regulate appearance settings used to paint bar and Ribbon objects in different visual states.
TabFormA tabbed UI form that allows you to add custom buttons (Bar Items) to the form’s header. Tabs and custom buttons can be incorporated directly in the title bar.
TabFormControlThe TabForm‘s header.
TabFormControlBaseThe base class for the TabFormControl.
TabFormPageA page in the TabFormControl.

Delegates

NameDescription
BarCustomDrawEventHandlerRepresents a method that will handle the BarCustomContainerItem.PaintMenuBar and PopupMenu.PaintMenuBar events.
BarItemCustomDrawEventHandlerThe method for handling events which take a BarItemCustomDrawEventArgs object as a parameter.
BarManagerMergeEventHandlerRepresents a method that will handle the BarManager.Merge and BarManager.UnMerge events.
CreateCustomizationFormEventHandlerRepresents a method that will handle the BarManager.CreateCustomizationForm event of the BarManager class.
CreateToolbarEventHandlerRepresents a method that will handle the BarManager.CreateToolbar event of the BarManager class.
HighlightedLinkChangedEventHandlerRepresents a method that will handle the BarManager.HighlightedLinkChanged event.
ItemCancelEventHandlerRepresents a method that will handle the BarEditItem.ShowingEditor event of the BarEditItem class.
ItemClickEventHandlerRepresents a method that will handle the BarItem.ItemClick event of the BarItem class.
LinkEventHandlerRepresents a method that will handle events that require a link as the parameter.
ListItemClickEventHandlerRepresents a method that will handle the BarListItem.ListItemClick event.
QueryShowPopupMenuEventHandlerRepresents a method that will handle the BarManager.QueryShowPopupMenu event of the BarManager class.
ShortcutItemClickEventHandlerRepresents a method that will handle the BarManager.ShortcutItemClick event.
ShowToolbarsContextMenuEventHandlerRepresents a method that will handle the BarManager.ShowToolbarsContextMenu event.

Enums

NameDescription
AnimationTypeLists values specifying the manner in which the item’s menu appears onscreen.
BarButtonStyleSpecifies the BarButtonItem control style.
BarCanDockStyleSpecifies how a bar can be docked.
BarDockStyleEnumerates dock styles for bar objects.
BarItemBorderStyleSpecifies border settings for a specific item.
BarItemCaptionAlignmentContains values specifying the position of caption text relative to the image.
BarItemEventFireModeContains values that specify when the Click events for a bar item fire.
BarItemPaintStyleDefines the paint style for a specific item.
BarItemVisibilityContains values specifying the visibility of links.
BarLinkUserDefinesLists values specifying which link settings are determined by a user.
BarMdiMenuMergeStyleContains values specifying when the merge mechanism should be invoked.
BarMenuMergeContains values specifying how bar items of a child MDI form are added to bars/Ribbon Controls of the parent MDI form during merge operations.
BarOptionFlagsContains flags that define the bar’s look and feel.
BarStaticItemSizeEnumerates values that specify whether a BarStaticItem is automatically stretched to fill all available free space in a bar.
MenuDrawModeEnumerates menu display modes.
PopupShowModeProvides members that specify how popup sub-menus are shown.
ToolTipAnchorContains values that specify the anchor point relative to which tooltips are displayed for BarItems within a BarManager.