Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Collapse]DevExpress.XtraBars
    AnimationType Enumeration
   [Expand]Bar Class
   [Expand]BarAndDockingController Class
   [Expand]BarAndDockingControllerLookAndFeel Class
   [Expand]BarBaseButtonItem Class
   [Expand]BarBaseButtonItemLink Class
   [Expand]BarButtonGroup Class
   [Expand]BarButtonGroupLink Class
   [Expand]BarButtonItem Class
   [Expand]BarButtonItemLink Class
    BarButtonStyle Enumeration
    BarCanDockStyle Enumeration
   [Expand]BarCheckItem Class
   [Expand]BarCheckItemLink Class
   [Expand]BarCustomContainerItem Class
   [Expand]BarCustomContainerItemLink Class
   [Expand]BarCustomDrawEventArgs Class
    BarCustomDrawEventHandler Delegate
   [Expand]BarDockControl Class
   [Expand]BarDockingMenuItem Class
   [Expand]BarDockingMenuItemLink Class
    BarDockStyle Enumeration
   [Expand]BarDockWindow Class
   [Expand]BarDockWindowCollection Class
   [Expand]BarEditItem Class
   [Expand]BarEditItemLink Class
   [Expand]BarHeaderItem Class
   [Expand]BarHeaderItemLink Class
   [Collapse]BarItem Class
     BarItem Members
    [Expand]BarItem Properties
    [Expand]BarItem Events
    [Expand]BarItem Methods
    BarItemBorderStyle Enumeration
    BarItemCaptionAlignment Enumeration
   [Expand]BarItemCustomDrawEventArgs Class
    BarItemCustomDrawEventHandler Delegate
    BarItemEventFireMode Enumeration
   [Expand]BarItemLink Class
   [Expand]BarItemLinkCollection Class
   [Expand]BarItemLinkReadOnlyCollection Class
    BarItemPaintStyle Enumeration
   [Expand]BarItems Class
    BarItemVisibility Enumeration
   [Expand]BarLargeButtonItem Class
   [Expand]BarLargeButtonItemLink Class
   [Expand]BarLinkContainerItem Class
   [Expand]BarLinkContainerItemLink Class
    BarLinkUserDefines Enumeration
   [Expand]BarListItem Class
   [Expand]BarListItemLink Class
   [Expand]BarManager Class
   [Expand]BarManagerAppearances Class
   [Expand]BarManagerCategory Class
   [Expand]BarManagerCategoryCollection Class
   [Expand]BarManagerMergeEventArgs Class
    BarManagerMergeEventHandler Delegate
   [Expand]BarManagerProperties Class
   [Expand]BarMdiChildrenListItem Class
   [Expand]BarMdiChildrenListItemLink Class
    BarMdiMenuMergeStyle Enumeration
    BarMenuMerge Enumeration
    BarOptionFlags Enumeration
   [Expand]BarOptions Class
   [Expand]Bars Class
   [Expand]BarShortcut Class
   [Expand]BarStaticItem Class
   [Expand]BarStaticItemLink Class
    BarStaticItemSize Enumeration
   [Expand]BarSubItem Class
   [Expand]BarSubItemLink Class
   [Expand]BarToggleSwitchItem Class
   [Expand]BarToggleSwitchItemLink Class
   [Expand]BarToolbarsListItem Class
   [Expand]BarToolbarsListItemLink Class
   [Expand]BaseBarManagerOptions Class
   [Expand]CreateCustomizationFormEventArgs Class
    CreateCustomizationFormEventHandler Delegate
   [Expand]CreateToolbarEventArgs Class
    CreateToolbarEventHandler Delegate
   [Expand]DefaultBarAndDockingController Class
   [Expand]HighlightedLinkChangedEventArgs Class
    HighlightedLinkChangedEventHandler Delegate
   [Expand]ItemCancelEventArgs Class
    ItemCancelEventHandler Delegate
   [Expand]ItemClickEventArgs Class
    ItemClickEventHandler Delegate
   [Expand]LinkEventArgs Class
    LinkEventHandler Delegate
   [Expand]ListItemClickEventArgs Class
    ListItemClickEventHandler Delegate
   [Expand]MenuAppearance Class
    MenuDrawMode Enumeration
   [Expand]PopupControlContainer Class
   [Expand]PopupMenu Class
   [Expand]PopupMenuBase Class
    PopupShowMode Enumeration
   [Expand]QueryShowPopupMenuEventArgs Class
    QueryShowPopupMenuEventHandler Delegate
   [Expand]RibbonAppearances Class
   [Expand]RibbonGalleryAppearances Class
   [Expand]RibbonGalleryBarItem Class
   [Expand]RibbonGalleryBarItemLink Class
   [Expand]RibbonProperties Class
   [Expand]ShortcutItemClickEventArgs Class
    ShortcutItemClickEventHandler Delegate
   [Expand]ShowToolbarsContextMenuEventArgs Class
    ShowToolbarsContextMenuEventHandler Delegate
   [Expand]StandaloneBarDockControl Class
   [Expand]StateAppearances Class
   [Expand]Strings Class
   [Expand]TabForm Class
   [Expand]TabFormControl Class
   [Expand]TabFormControlBase Class
   [Expand]TabFormPage Class
    ToolTipAnchor Enumeration
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

BarItem Members

Provides the functionality of bar elements.

Expanded Public Properties

Show: Inherited
  Name Description
Public property AccessibleDescription Gets or sets the description of the bar item used by accessibility client applications.
Public property AccessibleName Gets or sets the bar item's name which is used by accessibility client applications.
Public property Alignment Gets or sets the horizontal alignment of the item's link(s).
Public property AllowGlyphSkinning Gets or sets whether glyphs for this BarItem should be painted using the text foreground color.
Public property AllowHtmlText Gets or sets whether the Caption and Description can be formatted using HTML tags.
Public property AllowRightClickInMenu Gets or sets if the current command's functionality is invoked via the right mouse click when in a sub-menu or popup menu.
Public property AllowStubGlyph Gets or sets whether or not this item and all its links should display a stub glyph when it has no custom icon assigned.
Public property Appearance Provides access to the appearance settings for the current bar item, applied when the bar item is in the regular state.
Public property AppearanceDisabled Provides access to the appearance settings for the current bar item, applied when the bar item is disabled. This property is supported for bar items used within a RibbonControl.
Public property BindingContext Gets or sets a BindingContext object that manages data bindings for this BarItem.
Public property Border Gets or sets the border style for links that refer to the current item.
Public property BorderStyle Obsolete. Specifies the border style for the current BarItem.
Public property Caption A string containing the item's caption.
Public property Category Gets or sets a category where the bar item is displayed.
Public property CategoryGuid Gets or sets a globally unique identifier (GUID) that identifies the category where the item is displayed.
Public property CategoryIndex Obsolete. Gets or sets the index of the category to which the current item belongs.
Public property CausesValidation Gets or sets whether data validation is performed on the currently focused control when clicking on the bar item.
Public property Container Gets the System.ComponentModel.IContainer that contains the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property ContentHorizontalAlignment Gets or sets the horizontal alignment mode for this BarItem's content.
Public property DataBindings Provides access to the collection of data bindings for the BarItem.
Public property Description Specifies the bar item's description.
Public property DropDownSuperTip Gets or sets a SuperToolTip object that is displayed when the current item displays a separate dropdown arrow and this arrow is hot-tracked.
Public property Enabled Determines whether the current BarItem is active.
Public property Font Gets the font to display links of the current item.
Public property Glyph Gets or sets the item's image.
Public property GlyphDisabled Gets or sets the image corresponding to the item's disabled state.
Public property Hint Specifies the bar item's regular hint.
Public property Id Uniquely identifies the current BarItem.
Public property ImageIndex Gets or sets the index of a small image assigned to the item.
Public property ImageIndexDisabled Gets or sets the index of the image displayed within corresponding links when they are disabled.
Public property ImageOptions Provides access to all properties that allow you to assign and customize an icon for this BarItem.
Public property Images Gets the object which contains images that can be displayed within the current item.
Public property ImageUri Gets or sets the uniform resource identifier of the image in the DX Image Gallery displayed in the current item. A specific version of the addressed image is automatically chosen based on the app context (the current skin and required image size).
Public property IsAllowHtmlText Gets whether HTML tags can be used to format bar item captions.
Public property IsImageExist Gets whether an image which is associated with the bar item actually exists.
Public property IsLargeImageExist Gets whether a large image which is associated with the bar item actually exists.
Public property ItemAppearance Provides appearance settings used to paint links to the current BarItem object when the links are in different visual states.
Public property ItemClickFireMode Gets or sets when the Click events for the bar item fire, immediately or asynchronously, after all events in the system event queue are processed.
Public property ItemInMenuAppearance Provides appearance settings used to paint links to the current BarItem in different visual states when they are displayed within a sub-menu or popup menu.
Public property ItemShortcut Gets or sets the shortcut used to access associated links using the keyboard.
Public property LargeGlyph Gets or sets the item's large image.
Public property LargeGlyphDisabled Gets or sets the large image that corresponds to the item's disabled state.
Public property LargeImageIndex Gets or sets the index of the large image which is displayed within the item's link(s).
Public property LargeImageIndexDisabled Gets or sets the index of the large image which is displayed within the disabled item's link(s).
Public property LargeImages Gets the source of large images
Public property LargeWidth Gets or sets the width of links corresponding to the current item, when they are painted using the RibbonItemStyles.Large paint style. This property is in effect for bar item links displayed within the Ribbon Control and RibbonStatusBar controls.
Public property Links Gets the collection of links to the item.
Public property Manager Specifies the BarManager responsible for managing the current item.
Public property MergeOrder Defines the visual position of the bar item after merging bars on a parent MDI form.
Public property MergeType Gets or sets how the item behaves during merge operations in MDI applications.
Public property Name Gets or sets the BarItem's name.
Public property OwnFont Obsolete. Specifies the font used to display the captions of links corresponding to this item.
Public property PaintStyle Specifies the style with which to display a specific BarItem within a bar.
Public property RibbonStyle Gets or sets the options that specify the bar item's possible states within a Ribbon Control.
Public property ShortCut Obsolete. Specifies the shortcut key combination for the current item.
Public property ShortcutKeyDisplayString Gets or sets a custom display string for the shortcut assigned to the item via the ItemShortcut property.
Public property ShowInCustomizationForm Gets or sets whether the bar item is visible at runtime in the Customization Window.
Public property ShowItemShortcut Gets or sets whether this BarItem should display its shortcut in sub-menus and pop-up menus.
Public property Site Gets or sets the System.ComponentModel.ISite of the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property Size Gets or sets the BarItem's size.
Public property SmallWithoutTextWidth Gets or sets the width of links corresponding to the current item, when they are painted using the RibbonItemStyles.SmallWithoutText paint style. This property is in effect for bar item links displayed within the Ribbon Control and RibbonStatusBar controls.
Public property SmallWithTextWidth Gets or sets the width of links corresponding to the current item, when they are painted using the RibbonItemStyles.SmallWithText paint style. This property is in effect for bar item links displayed within the Ribbon Control and RibbonStatusBar controls.
Public property SuperTip Gets or sets a SuperToolTip for the current bar item.
Public property Tag Gets or sets an object that contains data on the current item.
Public property UseOwnFont Obsolete. Gets or sets whether the item's links are painted using the item's own font (Appearance.Font).
Public property Visibility Specifies when a specific item is visible.
Public property VisibleWhenVertical Determines whether an item is visible when the bar is vertically oriented .
Public property Width When overridden in a derived class, this property specifies the current item width.
Top

Expanded Public Methods

Show: Inherited
  Name Description
Public method BeginUpdate Locks the BarItem object by preventing visual updates until the EndUpdate method is called.
Public method CancelUpdate Unlocks the object after it has been locked by the BeginUpdate method, without causing an immediate visual update.
Public method ContainsItem Indicates whether the item contains the item specified.
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public method Dispose Releases all resources used by the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public method EndUpdate Unlocks the BarItem object after a call to the BeginUpdate method and causes an immediate visual update.
Public methodStatic member Equals Determines whether the specified System.Object instances are considered equal. (Inherited from System.Object)
Public method Equals Determines whether the specified System.Object is equal to the current System.Object. (Inherited from System.Object)
Public method GetBarLinkInfoProvider This member supports the internal infrastructure, and is not intended to be used directly from your code.
Public method GetHashCode Serves as a hash function for a particular type. System.Object.GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from System.Object)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public method GetType Gets the System.Type of the current instance. (Inherited from System.Object)
Public method GetVisibleLinks Returns the list of all currently visible links to this BarItem.
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public method PerformClick Overloaded. Fires the ItemClick events for the current bar item.
Public methodStatic member ReferenceEquals Determines whether the specified System.Object instances are the same instance. (Inherited from System.Object)
Public method Refresh Forces the controls that contain the bar item's links to invalidate their client area.
Public method Reset Resets the current BarItem to the original state.
Public method ResetDropDownSuperTip Clears the SuperTip that has been assigned to the DropDownSuperTip property.
Public method ResetSuperTip Removes the SuperToolTip object that has been assigned to the current bar item.
Public method ToString Returns a System.String containing the name of the System.ComponentModel.Component, if any. This method should not be overridden. (Inherited from System.ComponentModel.Component)
Public method UpdateBindings Updates data bindings used by this BarItem.
Top

Expanded Public Events

Show: Inherited
  Name Description
Public event Disposed Occurs when the component is disposed by a call to the System.ComponentModel.Component.Dispose method. (Inherited from System.ComponentModel.Component)
Public event HyperlinkClick Occurs each time an end-user click a hyperlink within the current BarItem.
Public event ItemClick Occurs when the current item is clicked.
Public event ItemDoubleClick Fires when a link to an item is double-clicked.
Public event ItemPress Fires immediately after a link associated with an item has been pressed.
Top

Expanded See Also

How would you rate this topic?​​​​​​​