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.v24.1.dll
NuGet Package: DevExpress.Win.Navigation
Classes
Name | Description |
---|---|
Bar | Represents a Windows-like toolbar. |
BarAndDockingController | Allows 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). |
BarAndDockingControllerLookAndFeel | Contains look and feel settings for the controls/components that are managed by a BarAndDockingController. |
BarBaseButtonItem | Serves as a base class for classes that implement functionality for button items. |
BarBaseButtonItemLink | Represents a link to the BarBaseButtonItem item. |
BarButtonGroup | Represents a group of links that correspond to the bar button items. |
BarButtonGroupLink | Represents a link to the BarButtonGroup item. |
BarButtonItem | A button command in the Ribbon UI, toolbar, or popup menu. |
BarButtonItemLink | A bar item link to BarButtonItem. |
BarCheckItem | A bar item with toggle button functionality. |
BarCheckItemImageOptions | Contains options that specify images and image settings for BarCheckItem objects. |
BarCheckItemLink | Represents a link to the BarCheckItem. |
BarCustomContainerItem | Provides the functionality for all container items. |
BarCustomContainerItemLink | Represents a bar element that can contain links to other items. |
BarCustomDrawEventArgs | Provides data for the BarCustomContainerItem.PaintMenuBar and PopupMenu.PaintMenuBar event. |
BarDockControl | Represents a Bar Dock Control. |
BarDockingMenuItem | Displays commands to manipulate documents that are created by the DocumentManager. |
BarDockingMenuItemLink | Displays a BarDockingMenuItem within a bar or a menu. |
BarDockWindow | Obsolete. Represents a dock window. |
BarDockWindowCollection | Represents the collection of BarDockWindow objects. |
BarEditItem | A bar item that contains an editor. |
BarEditItemLink | Represents the BarEditItem within a bar or a menu. |
BarHeaderItem | Displays 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. |
BarHeaderItemLink | A link to the BarHeaderItem object. |
BarItem | Provides the functionality of bar elements. |
BarItemCustomDrawEventArgs | Provides data for the BarManager.CustomDrawItem event. |
BarItemImageOptions | Provides options to specify images and image settings for bar items. |
BarItemLink | Specifies a bar element. |
BarItemLinkCollection | A collection of bar item links. |
BarItemLinkReadOnlyCollection | A read-only bar item link collection. |
BarItems | Represents a collection of existing items for a specific BarManager. |
BarLargeButtonItem | A bar item that displays a large image in a toolbar. |
BarLargeButtonItemLink | Represents a link to a large button item. |
BarLinkContainerItem | Represents a link container. |
BarLinkContainerItemLink | Represents a bar element with a submenu contaning links. |
BarListItem | A bar item containing a list of items. |
BarListItemLink | Represents a BarListItem within a bar or a menu. |
BarManager | The component that manages traditional bars and popup menus. |
BarManagerAppearances | Contains default style settings for bars and their elements. |
BarManagerCategory | An individual category. |
BarManagerCategoryCollection | A category collection in the BarManager. |
BarManagerMergeEventArgs | Provides data for the BarManager.Merge and BarManager.UnMerge events. |
BarManagerProperties | Contains default customization settings for bars. |
BarMdiChildrenListItem | Represents a bar item containing a list of active windows in an MDI applications. |
BarMdiChildrenListItemLink | Represents a BarMdiChildrenListItem within a bar or a menu. |
BarOptions | Provides customization options for a bar. |
Bars | Represents the bars collection. |
BarShortcut | Contains item shortcut settings. |
BarStaticItem | Represents a bar item with a look and feel similar to the StatusbarPanel. |
BarStaticItemLink | Represents the BarStaticItem within a bar or a menu. |
BarSubItem | A sub-menu that contains other bar items (including child sub-menus). |
BarSubItemLink | Represents the BarSubItemLink link within a bar or a menu. |
BarToggleSwitchItem | A Windows UI-style check button, which can have the checked and unchecked states. |
BarToggleSwitchItemLink | A link to the BarToggleSwitchItem object. |
BarToolbarsListItem | A bar item that represents a check list of bars owned by a Bar Manager, and dock panels owned by a dock manager. |
BarToolbarsListItemLink | Represents a link to the BarToolbarsListItem. |
BaseBarManagerOptions | The base class for classes that store bar options. |
CreateCustomizationFormEventArgs | Provides data for the BarManager.CreateCustomizationForm event. |
CreateToolbarEventArgs | Provides data for the BarManager.CreateToolbar event of the BarManager component. |
DefaultBarAndDockingController | Allows 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). |
FormAssistant | Converts a regular form to a DevExpress form and backwards. |
HighlightedLinkChangedEventArgs | Provides data for the BarManager.HighlightedLinkChanged event. |
ItemCancelEventArgs | Provides data for the BarEditItem.ShowingEditor event. |
ItemClickEventArgs | Provides data for the BarItem.ItemClick and BarManager.ItemClick events. |
LinkEventArgs | Provides data for events that require a link as the parameter. |
ListItemClickEventArgs | Provides data for the BarListItem.ListItemClick event. |
MenuAppearance | Contains style settings used to customize items within popup menus and container items. |
PopupControlContainer | The control container that can be displayed as a dropdown. |
PopupMenu | The popup menu, managed by a BarManager or RibbonControl. |
PopupMenuBase | The base class for popup menus. |
QueryShowPopupMenuEventArgs | Provides data for the BarManager.QueryShowPopupMenu event of the BarManager component. |
RibbonAppearances | Provides the appearance settings used to paint a Ribbon Control. |
RibbonGalleryAppearances | Provides appearance settings that are used to paint Ribbon gallery elements. |
RibbonGalleryBarItem | A bar item that represents an In-Ribbon gallery. |
RibbonGalleryBarItemLink | Represents a link to a RibbonGalleryBarItem object. |
RibbonProperties | Contains settings that control the display of bar items in a RibbonControl. |
ShortcutItemClickEventArgs | Provides data for the BarManager.ShortcutItemClick event. |
ShowToolbarsContextMenuEventArgs | Provides data for the BarManager.ShowToolbarsContextMenu event. |
StandaloneBarDockControl | The control that can accommodate bars and display them at any position within the form. |
StateAppearances | Provides a set of properties that regulate appearance settings used to paint bar and Ribbon objects in different visual states. |
TabForm | A 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. |
TabFormControl | The TabForm‘s header. |
TabFormControlBase | The base class for the TabFormControl. |
TabFormPage | A page in the TabFormControl. |
Delegates
Name | Description |
---|---|
BarCustomDrawEventHandler | Represents a method that will handle the BarCustomContainerItem.PaintMenuBar and PopupMenu.PaintMenuBar events. |
BarItemCustomDrawEventHandler | The method for handling events which take a BarItemCustomDrawEventArgs object as a parameter. |
BarManagerMergeEventHandler | Represents a method that will handle the BarManager.Merge and BarManager.UnMerge events. |
CreateCustomizationFormEventHandler | Represents a method that will handle the BarManager.CreateCustomizationForm event of the BarManager class. |
CreateToolbarEventHandler | Represents a method that will handle the BarManager.CreateToolbar event of the BarManager class. |
HighlightedLinkChangedEventHandler | Represents a method that will handle the BarManager.HighlightedLinkChanged event. |
ItemCancelEventHandler | Represents a method that will handle the BarEditItem.ShowingEditor event of the BarEditItem class. |
ItemClickEventHandler | Represents a method that will handle the BarItem.ItemClick event of the BarItem class. |
LinkEventHandler | Represents a method that will handle events that require a link as the parameter. |
ListItemClickEventHandler | Represents a method that will handle the BarListItem.ListItemClick event. |
QueryShowPopupMenuEventHandler | Represents a method that will handle the BarManager.QueryShowPopupMenu event of the BarManager class. |
ShortcutItemClickEventHandler | Represents a method that will handle the BarManager.ShortcutItemClick event. |
ShowToolbarsContextMenuEventHandler | Represents a method that will handle the BarManager.ShowToolbarsContextMenu event. |
Enums
Name | Description |
---|---|
AnimationType | Lists values specifying the manner in which the item’s menu appears onscreen. |
BarButtonStyle | Specifies the BarButtonItem control style. |
BarCanDockStyle | Specifies how a bar can be docked. |
BarDockStyle | Enumerates dock styles for bar objects. |
BarItemBorderStyle | Specifies border settings for a specific item. |
BarItemCaptionAlignment | Contains values specifying the position of caption text relative to the image. |
BarItemEventFireMode | Contains values that specify when the Click events for a bar item fire. |
BarItemPaintStyle | Defines the paint style for a specific item. |
BarItemVisibility | Contains values specifying the visibility of links. |
BarLinkUserDefines | Lists values specifying which link settings are determined by a user. |
BarMdiMenuMergeStyle | Contains values specifying when the merge mechanism should be invoked. |
BarMenuMerge | Contains values specifying how bar items of a child MDI form are added to bars/Ribbon Controls of the parent MDI form during merge operations. |
BarOptionFlags | Contains flags that define the bar’s look and feel. |
BarStaticItemSize | Enumerates values that specify whether a BarStaticItem is automatically stretched to fill all available free space in a bar. |
MenuDrawMode | Enumerates menu display modes. |
PopupShowMode | Provides members that specify how popup sub-menus are shown. |
ToolTipAnchor | Contains values that specify the anchor point relative to which tooltips are displayed for BarItems within a BarManager. |