BarItemSelector Class

A container for bar items that can have only one selected item.

Namespace: DevExpress.Xpf.Bars

Assembly: DevExpress.Xpf.Core.v24.1.dll

NuGet Package: DevExpress.Wpf.Core

Declaration

C#

public class BarItemSelector :
    BarLinkContainerItem

VB.NET

Public Class BarItemSelector
    Inherits BarLinkContainerItem

Remarks

You can use the BarItemSelector to group BarCheckItems. Once a user checks an item, the selector unchecks the previously selected item.

XAML

<dxb:ToolBarControl>
    <dxb:BarItemSelector>
        <dxb:BarCheckItem Glyph="{dx:DXImage 'SvgImages/Icon Builder/Actions_Question.svg'}"/>
        <dxb:BarCheckItem Glyph="{dx:DXImage 'SvgImages/Icon Builder/Security_Warning.svg'}"/>
        <dxb:BarCheckItem Glyph="{dx:DXImage 'SvgImages/Icon Builder/Security_WarningCircled1.svg'}"/>
    </dxb:BarItemSelector>
</dxb:ToolBarControl>

The BarItemSelector does not allow users to uncheck items. Set the AllowEmptySelection property to true to change this behavior.

Generate Items from the View Model

The BarItemSelector can obtain its items from the View Model collection:

1. Create a collection of items that should be displayed in the BarItemSelector:

   C#

   public class Priority {
       public int Id { get; set; }
       public string Name { get; set; }
   }
   
   public class ViewModel : ViewModelBase {
       public ViewModel() {
           Priorities = new ObservableCollection<Priority> {
               new Priority() { Id = 0, Name = "Low" },
               new Priority() { Id = 1, Name = "Normal" },
               new Priority() { Id = 2, Name = "High" }
           };
           SelectedPriority = Priorities.FirstOrDefault();
       }
       public ObservableCollection<Priority> Priorities { get; }
       public Priority SelectedPriority { get { return GetValue<Priority>(); } set { SetValue(value); } }
   }
   

   VB.NET

   Public Class Priority
       Public Property Id As Integer
       Public Property Name As String
   End Class
   
   Public Class ViewModel
       Inherits ViewModelBase
   
       Public Sub New()
           Priorities = New ObservableCollection(Of Priority) From {
               New Priority() With { .Id = 0, .Name = "Low" },
               New Priority() With { .Id = 1, .Name = "Normal" },
               New Priority() With { .Id = 2, .Name = "High" }
           }
           SelectedPriority = Priorities.FirstOrDefault()
       End Sub
   
       Public ReadOnly Property Priorities As ObservableCollection(Of Priority)
   
       Public Property SelectedPriority As Priority
           Get
               Return GetValue(Of Priority)()
           End Get
           Set(ByVal value As Priority)
               SetValue(value)
           End Set
       End Property
   End Class
   

2. Bind the ItemLinksSource property to the created collection.

3. Specify a template that generates items and assign it to the ItemTemplate property.
4. The SelectedItem property allows you to define a checked item in the View Model.

XAML

<dxb:BarSubItem Content="Priority">
    <dxb:BarItemSelector ItemLinksSource="{Binding Priorities}"
                         SelectedItem="{Binding SelectedPriority}">
        <dxb:BarItemSelector.ItemTemplate>
            <DataTemplate>
                <ContentControl>
                    <dxb:BarCheckItem Content="{Binding Name}"/>
                </ContentControl>
            </DataTemplate>
        </dxb:BarItemSelector.ItemTemplate>
    </dxb:BarItemSelector>
</dxb:BarSubItem>

Implements

IControllerAction

ILinksHolder

Inheritance

Object

DispatcherObject

DependencyObject

ContentElement

FrameworkContentElement

BarItem

BarLinkContainerItem

BarItemSelector