Data Binding in WPF CheckListBox control

29 May 20243 minutes to read

The control can be populated using ItemsSource property and DisplayMemberPath property used to display the items and IsSelected property used to handle the selection in the CheckListBox. The below code snippet will be used to bind the ItemsSource to the CheckListBox.

XAML

<syncfusion:CheckListBox x:Name="checkListBox" IsCheckOnFirstClick="True" DisplayMemberPath="Name" ItemsSource="{Binding CheckListItems}">
    <syncfusion:CheckListBox.ItemContainerStyle>
      <Style TargetType="syncfusion:CheckListBoxItem">
        <Setter Property="IsSelected" Value="{Binding IsChecked,Mode=TwoWay"/>
      </Style>
    </syncfusion:CheckListBox.ItemContainerStyle>
</syncfusion:CheckListBox>

C#

public class ViewModel : INotifyPropertyChanged
{
    public event PropertyChangedEventHandler PropertyChanged;
    private ObservableCollection<Model> _checkListItems;
    public ObservableCollection<Model> CheckListItems
    {
        get
        {
            return _checkListItems;
        }
        set
        {
            _checkListItems = value;
            RaisePropertyChanged("CheckListItems");
        }
    }
    public ViewModel()
    {
        CheckListItems = new ObservableCollection<Model>();
        CheckListItems.Add(new Model() { Name = "Mexico", Description = "Mexico", IsChecked = true });
        CheckListItems.Add(new Model() { Name = "Canada", Description = "Canada ", IsChecked = true });
        CheckListItems.Add(new Model() { Name = "Bermuda",Description = "Bermuda", IsChecked = false});   
        CheckListItems.Add(new Model() { Name = "Beize", Description = "Beize", IsChecked = false});               
        CheckListItems.Add(new Model() { Name = "Panama", Description = "Panama", IsChecked = true });  
    }
    public void RaisePropertyChanged(string PropertyName)
    {
        if (PropertyChanged != null)
        {
            PropertyChanged(this, new PropertyChangedEventArgs(PropertyName));
        }
    }
}
public class Model
{
    public string Name { get; set; }
    public string Description { get; set; }
    public bool IsChecked { get; set; }
}