BarHeaderItem.MultiColumn Property
Gets or sets whether to arrange items displayed below the BarHeaderItem in columns.
Namespace: DevExpress.XtraBars
Assembly: DevExpress.XtraBars.v24.1.dll
NuGet Package: DevExpress.Win.Navigation
Declaration
[DefaultValue(DefaultBoolean.Default)]
[DXCategory("Appearance")]
public DefaultBoolean MultiColumn { get; set; }
Property Value
Type | Default | Description |
---|---|---|
DefaultBoolean | Default | A DefaultBoolean enumeration value that specifies whether to arrange items in columns. |
Available values:
Name | Description | Return Value |
---|---|---|
True | The value is true. |
|
False | The value is false. |
|
Default | The value is specified by a global option or a higher-level object. |
|
Remarks
Sub-menus (BarSubItem) and pup-up menus (PopupMenu) display items in a column. Header items (BarHeaderItem) allow you to group menu items. Enable the MultiColumn
option to display menu items in multiple columns.
Use the BarHeaderItem.OptionsMultiColumn property to access settings specific to multi-column display mode. For example, the BarHeaderItem.OptionsMultiColumn.ColumnCount
property specifies the number of columns. The BarHeaderItem.OptionsMultiColumn.ItemDisplayMode
property specifies whether to display item text, image, or text and image.
The following screenshot shows a sub-menu that displays menu items in the Format header in single and multiple columns:
The MultiColumn
property enables the multi-column mode only for the set of items below the current BarHeaderItem. If the MultiColumn
property is set to Default, behavior depends on settings of the menu that contains items.
To enable the multi-column mode for all items in sub-menus or pup-up menus, use the BarLinkContainerItem.MultiColumn and PopupMenu.MultiColumn properties, respectively. Multi-column mode settings for these menus are accessible using the BarLinkContainerItem.OptionsMultiColumn and PopupMenu.OptionsMultiColumn properties, respectively. Conversely, you can override the global menu settings for the set of items below the current header, using the MultiColumn and BarHeaderItem.OptionsMultiColumn properties.
You can also use the BarAndDockingController component to control multi-column mode settings in a centralized way. The BarManagerProperties.OptionsMultiColumn property, accessible using the BarAndDockingController.PropertiesBar property, allows you specify multi-column mode settings for all sub-menus and pop-up menus controlled by the BarManager (see BarManager.Controller). The settings provided using the BarHeaderItem.OptionsMultiColumn property override these global settings.