BarListItem Class
A bar item containing a list of items.
Namespace: DevExpress.XtraBars
Assembly: DevExpress.XtraBars.v24.2.dll
NuGet Package: DevExpress.Win.Navigation
#Declaration
public class BarListItem :
BarCustomContainerItem,
IXtraSerializable
#Remarks
BarListItem items are useful for the display of numerated lists of strings. Examples of numerated lists include: lists of the recently used files and lists of active windows in MDI applications.
By entering a minus symbol in the strings list, you can insert a separator line into the list. This is similar to assigning true to a bar item link’s BarItemLink.BeginGroup property.
When creating numerated lists, the BarListItem.ShowNumbers property value must be set to true. In this instance, each text string is prefixed by a number:
When the BarListItem.ShowChecks property value is true, the active item in the list is highlighted with a check mark:
If the BarListItem is placed on a toolbar, this item appears as a submenu.
If the BarListItem is placed on a submenu, this item is presented as a string list.
At design time, BarListItem elements located in a menu are hidden as described in the following image:
At runtime, the BarListItem expands all its items as described in the following image:
To add items (strings) to a BarListItem object, use the BarListItem.Strings collection.
Important
If you create a bar item in code, associate the bar item with the BarBar
parameter. To display the bar item within the Ribbon Control, pass the RibbonBar
parameter.