A Custom CheckedListBox with Datasource Implementation (Bindable)

Download source - 28.13 KB

Introduction

Due to the fact that .NET CheckedListBox does not have out of the box binding facilities, this article implements an extension of the CheckedListBox which can be bindable. Moreover, it implements the DisplayMember and ValueMember properties in order to get an array of IDs containing the respective checked items.

Approach

We have to implement four extra properties:

DataSource
DisplayMember
ValueMember
ValueList

You already know the use of the first three but the last one is a List<int>. I chose int because we need the ID and most of the times in the lookup table, this ID is a number. I chose a List because the user can check more than one item, hence we need a list.

Using the Code

To use this code, you have to create an object whose type is cCheckedListBox and add it to your form:

cCheckedListBox cbGenreList = new cCheckedListBox();
cbGenreList.Location = new Point(8, 20);
cbGenreList.Size = new Size(130, 180);
this.grpGenres.Controls.Add(cbGenreList);

// Let's bind it to data from a Database
var GenreList = from c in databasebObjectContext.Genres orderby c.gnDescription select c;
cbGenreList.DataSource = GenreList.ToArray();
cbGenreList.DisplayMember = "gnDescription";
cbGenreList.ValueMember = "gnNumber";

To retrieve the values of the checked items :

List <int> selectedValues;
selectedValues= cbGenreList.ValueList;

To check some items by ID:

List<int> myValues = new List<int>(); 
myValues.Add(44);
myValues.Add(45);
myValues.Add(46);
cbGenreList.ValueList = myValues;

History

17th January, 2008: Article posted

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Ricardo Cuello

Software Developer (Junior)

Canada

Member

Article Top

Poor

Excellent

Add a reason or comment to your vote: x
Votes of 3 or less require a comment

Comments and Discussions

You must Sign In to use this message board. (secure sign-in)

Search this forum
	Profile popups Noise Layout Per page

what is the database schema look like.

macupryk

17:01 11 Jan '10

Small Mod

Roger Willcocks

16:51 22 Apr '09

As described in this article, if you assign the DisplayMember BEFORE you assign the DataSource, the DisplayMember is wiped (ValueMember is not, go figure). Make this change to preserve it.

EDIT: point to note, this is a behaviour of the base ListControl, not of CheckedListBox

        [DefaultValue("")]
        [AttributeProvider(typeof(IListSource))]
        [RefreshProperties(RefreshProperties.All)]
        [Browsable(true)]
        public new object DataSource
        {
            get
            {
                return base.DataSource;
            }
            set
            {
                string dm = this.DisplayMember;
                ((ListBox)this).DataSource = value;
                if (dm != this.DisplayMember)
                {
                    this.DisplayMember = dm;
                }
            }
        }

Roger Willcocks
Software Engineer
MCP, MCSD .NET
http://www.l-space-design.com/

Generics Are Wonderful :)

Roger Willcocks

16:12 22 Apr '09

Initialization error

Penko Mitev

6:16 18 Mar '09

Re: Initialization error

Radu Martin

4:00 31 Mar '09

Re: Initialization error

Pinx

2:21 1 Oct '09

Binding the list

Monir Sabbagh

2:50 5 Feb '09

Thank you for the great article.
I failed to bind the ValueList member to a int list in data, I got the folowing runtime exception:

"Runtime error //Cannot bind to the property or column RoleReports on the DataSource. Parameter name: dataMember"

Here are my whole code, can you help me please?

public class Report
{
public int ReportID { get; set; }
public string ReportName { get; set; }
}

public class Role
{
public int RoleID { get; set; }
public string RoleName { get; set; }
public List<int> RoleReports = new List<int>();
}

public List<Report> ReportList = new List<Report>();
public BindingList<Role> RoleList = new BindingList<Role>();

public Form1()
{
InitializeComponent();
cCheckedListBox1.Location = new Point(12, 113);
cCheckedListBox1.Size = new Size(184, 109);
this.Controls.Add(cCheckedListBox1);

ReportList.Add(new Report { ReportID = 1, ReportName = "MCSE" });
ReportList.Add(new Report { ReportID = 2, ReportName = "English" });
ReportList.Add(new Report { ReportID = 3, ReportName = "CCNA" });
ReportList.Add(new Report { ReportID = 4, ReportName = "MCSD" });

RoleList.Add(new Role { RoleID = 1, RoleName = "Administrator", RoleReports = new List<int>() { 1, 2, 3, 4 } });
RoleList.Add(new Role { RoleID = 2, RoleName = "Manager", RoleReports = new List<int>() { 1, 2,3 } });
RoleList.Add(new Role { RoleID = 3, RoleName = "Salse", RoleReports = new List<int>() { 2, 4 } });
RoleList.Add(new Role { RoleID = 4, RoleName = "Student", RoleReports = new List<int>() { 3 } });

}

private void Form1_Load(object sender, EventArgs e)
{
L_RoleID.DataBindings.Add("Text", RoleList, "RoleID", true);
TB_RoleName.DataBindings.Add("Text", RoleList, "RoleName", true);

cCheckedListBox1.DataSource = ReportList;
cCheckedListBox1.DisplayMember = "ReportName";
cCheckedListBox1.ValueMember = "ReportID";
//cCheckedListBox1.ValueList = new List<int>() { 2,4}; // worked
cCheckedListBox1.DataBindings.Add("ValueList", RoleList, "RoleReports", true); // run time error //Cannot bind to the property or column RoleReports on the DataSource. Parameter name: dataMember
}