Click here to Skip to main content
Click here to Skip to main content

Workaround for disappearing checks in the CheckedListBox control

, 24 Apr 2003
Rate this:
Please Sign up or sign in to vote.
The CheckedListBox control has a serious problem! It forgets the checks when its DataSource property is set. This is the most effective workaround I have found.

Introduction

As many reported on the newsgroups (including me!), the CheckedListBox control forgets which item is checked when the items have been filled using the DataSource property and when its Visible property is set to false, then back to true.  The problem also occurs when it is hosted on a TabControl and tabs are flipped.

I first ran into this issue in my first week of .NET development.  Very frustrating start!  Since then, I tried many workarounds but all were just an extreme pain in the neck, especially when I was trying to use them on more complex forms. 

Those workarounds included never setting the Visible property of the CheckedListBox to False.  Rather, I moved the control outside the form (ex: -5000, -5000).  It worked (most of the time), but some clients reported the problem even with this. 

I also tried saving all the checks in an array before setting Visible to False, then putting them back in the CheckedListBox on Visible=true but once again, I felt it was a quite ineffective way.

Back then, I did not know that this bug was related to the Datasource property.  I recently figured this out after pulling my hair for a couple hours.  I finally came up with a great and easy workaround...

The Workaround

As I mentioned earlier, the problem only occurs when DataSource is used to add the items to the CheckedListBox.  So the idea is, you guessed it, to NOT use DataSource! Smile | :)   Here's the code I came up with:

Private Sub SetClBoxDataSource(ByVal clb As CheckedListBox, 
                 ByVal dt As DataTable)

    'Clear it
    clb.Items.Clear()

    'Fill it
    Dim x As Integer
    For x = 0 To dt.DefaultView.Count - 1
        clb.Items.Add(dt.DefaultView.Item(x))
    Next

End Sub

Basically, what this code does is adding the items one by one using a simple loop.  Now, instead of using this code to fill up the CheckedListBox:

    CheckedListBox.DataSource = DataTable

You should do:

    SetClBoxDataSource(CheckedListBox, DataTable)

It couldn't be easier!  Only one line of code to change!

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Carl Mercier
Web Developer
Canada Canada
No Biography provided

Comments and Discussions

 
GeneralProblem in displaying the Checked items in WPF [modified] PinmemberSabariGE8-Feb-09 23:03 
GeneralCheckboxlist Dispaly Pinmembern_gchaitra16-Aug-07 23:56 
GeneralDropdown binding PinsussAnonymous21-Aug-05 2:52 
GeneralRe: Dropdown binding Pinmembermorteza5711-Jul-06 23:28 
GeneralThis problem Solved Pinmemberacukier5-Apr-05 11:58 
GeneralRe: This problem Solved PinmemberC a r l5-Apr-05 12:16 
GeneralRe: This problem Solved PinsussAnonymous5-Jul-05 12:05 
GeneralCheckedListBox Problem PinmembervrushaliD5-Jan-05 19:42 
GeneralUsing custom list class Pinmemberdcrane31-Aug-04 13:59 
GeneralI "receive"..System.Data.DataRowView Pinmembersjkdo21-Apr-04 11:25 
GeneralRe: I "receive"..System.Data.DataRowView PinsussAnonymous21-Apr-04 11:30 
GeneralRe: I "receive"..System.Data.DataRowView Pinmembersjkdo24-Apr-04 3:04 
GeneralTry this PinsussKetan Shukla25-Mar-04 11:42 
GeneralRe: Try this PinmemberKetan Shukla25-Mar-04 11:53 
GeneralRe: Try this PinmembervrushaliD5-Jan-05 19:45 
GeneralNo Datasource for CheckedListBox PinmemberDalePres10-Feb-04 14:48 
GeneralRe: No Datasource for CheckedListBox PinmemberChrisWard27-Oct-04 5:29 
Generaleasiest way Pinmemberbillzelf12-Sep-03 7:42 
GeneralRe: easiest way PinmemberRicalawaba21-Mar-04 16:14 
GeneralRelated link PinmemberMeisi25-Apr-03 18:24 
GeneralRe: Related link PinmemberCarl Mercier26-Apr-03 5:18 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.150129.1 | Last Updated 25 Apr 2003
Article Copyright 2003 by Carl Mercier
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid