Click here to Skip to main content
Click here to Skip to main content
Go to top

CheckBox Header Column For DataGridView

, 23 Aug 2007
Rate this:
Please Sign up or sign in to vote.
Presenting a solution for having CheckBox control in the header of DataGridView

Introduction

This article will show you how to create CheckBoxHeaderColumn for DataGridView. It will expose CheckBoxClicked event which you can consume in your client application.

Background

It is very common to have a list of items in DataGridView with a check box in the first column where your later action will depend on user selection. This can be very easily done by having a first column defined as DataGridViewCheckBoxCell object. But, how can your customer select all items in the list (let's say you are working on an email client app and the user wants to delete all of his 100 spams). This was the main idea to generate a class which will have a check box item in the header where the developer can have full control after the user checks/unchecks an item in the header. A common action is to check/uncheck all items in the DataGridView depending on whether the header is checked/unchecked.

Using the Code

The whole solution (control) is very simple and contains just one class DataGridViewCheckBoxHeaderCell.

On the client side, the developer just needs to define DataGridViewCheckBoxColumn and assign DataGridCheckBoxHeaderCell as a HeaderCell. Here is the code to do that:

DataGridViewCheckBoxColumn colCB = new DataGridViewCheckBoxColumn();
DatagridViewCheckBoxHeaderCell cbHeader = new DatagridViewCheckBoxHeaderCell();
colCB.HeaderCell = cbHeader;
datagridview1.Columns.Add(colCB);

As mentioned before, always user clicks on a Checkbox in the header object will fire CheckboxClicked event which you can consume in your application:

cbHeader.OnCheckBoxClicked += 
    new CheckBoxClickedHandler(cbHeader_OnCheckBoxClicked);

In the function cbHeader_OnCheckBoxClicked(), you can check/uncheck all of DataGridView rows or do any other action.

And here is a control source:

namespace TestRef
{   
    public delegate void CheckBoxClickedHandler(bool state);
    public class DataGridViewCheckBoxHeaderCellEventArgs : EventArgs
    {
        bool _bChecked;
        public DataGridViewCheckBoxHeaderCellEventArgs(bool bChecked)
        {
            _bChecked = bChecked;
        }
        public bool Checked
        {
            get { return _bChecked; }
        }
    }
    class DatagridViewCheckBoxHeaderCell : DataGridViewColumnHeaderCell
    {
        Point checkBoxLocation;
        Size checkBoxSize;
        bool _checked = false;
        Point _cellLocation = new Point();
        System.Windows.Forms.VisualStyles.CheckBoxState _cbState = 
            System.Windows.Forms.VisualStyles.CheckBoxState.UncheckedNormal;
        public event CheckBoxClickedHandler OnCheckBoxClicked;
 
        public DatagridViewCheckBoxHeaderCell()
        {           
        }

        protected override void Paint(System.Drawing.Graphics graphics, 
            System.Drawing.Rectangle clipBounds, 
            System.Drawing.Rectangle cellBounds, 
            int rowIndex, 
            DataGridViewElementStates dataGridViewElementState, 
            object value, 
            object formattedValue, 
            string errorText, 
            DataGridViewCellStyle cellStyle, 
            DataGridViewAdvancedBorderStyle advancedBorderStyle, 
            DataGridViewPaintParts paintParts)
        {
            base.Paint(graphics, clipBounds, cellBounds, rowIndex, 
                dataGridViewElementState, value, 
                formattedValue, errorText, cellStyle, 
                advancedBorderStyle, paintParts);
            Point p = new Point();
            Size s = CheckBoxRenderer.GetGlyphSize(graphics, 
            System.Windows.Forms.VisualStyles.CheckBoxState.UncheckedNormal);
            p.X = cellBounds.Location.X + 
                (cellBounds.Width / 2) - (s.Width / 2) ;
            p.Y = cellBounds.Location.Y + 
                (cellBounds.Height / 2) - (s.Height / 2);
            _cellLocation = cellBounds.Location;
            checkBoxLocation = p;
            checkBoxSize = s;
            if (_checked)
                _cbState = System.Windows.Forms.VisualStyles.
                    CheckBoxState.CheckedNormal;
            else
                _cbState = System.Windows.Forms.VisualStyles.
                    CheckBoxState.UncheckedNormal;
            CheckBoxRenderer.DrawCheckBox
            (graphics, checkBoxLocation, _cbState);
        }

        protected override void OnMouseClick(DataGridViewCellMouseEventArgs e)
        {
            Point p = new Point(e.X + _cellLocation.X, e.Y + _cellLocation.Y);
            if (p.X >= checkBoxLocation.X && p.X <= 
                checkBoxLocation.X + checkBoxSize.Width 
            && p.Y >= checkBoxLocation.Y && p.Y <= 
                checkBoxLocation.Y + checkBoxSize.Height)
            {
                _checked = !_checked;
                if (OnCheckBoxClicked != null)
                {
                    OnCheckBoxClicked(_checked);
                    this.DataGridView.InvalidateCell(this);
                }
                
            } 
            base.OnMouseClick(e);
        }     
    }
}

I hope you will find this article helpful while this is a solution used in our cross database comparison tool for selecting rows for synchronization between databases. Besides this, you can easily extend and fully customize painting of the CheckBox control, introduce tri state CheckBoxes and do many others as with the normal CheckBox.

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

DLM@TD
Software Developer (Senior)
Austria Austria
Working as a .NET and database developer

Comments and Discussions

 
QuestionUse Pinmemberaramosvizcarra28-Aug-14 3:26 
AnswerRe: Use PinmemberDLM@TD25-Sep-14 8:14 
SuggestionVersion based on CheckBoxState: unchecked, checked, mixed and normal, hot, pressed Pinmemberdethtroll27-Jan-12 5:16 
Questiona vb.net version Pinmemberjtxd30-Dec-11 15:32 
AnswerRe: a vb.net version PinmemberBrent Murphy11-Jan-12 3:27 
GeneralRe: a vb.net version Pinmembertallion18-Nov-12 13:33 
QuestionSetting 'DataPropertyName' stopped the OnCheckBoxClicked event firing Pinmembertrevormcalister17-Aug-11 4:31 
AnswerRe: Setting 'DataPropertyName' stopped the OnCheckBoxClicked event firing Pinmembermohammad forutan31-Jul-12 21:15 
GeneralThanks PingroupYZK30-Mar-11 0:03 
GeneralMy vote of 5 PinmemberJunfengGuo9-Mar-11 12:26 
AnswerEven much simpler and a way to remove checkbox in an individual cell of in an CheckboxColumn Pinmemberloibl24-Mar-09 5:53 
QuestionHow to uncheck the header check box when user click on the grid cell and uncheck any of the check box Pinmemberravikrmishra10-Feb-09 22:20 
AnswerRe: Solution: to uncheck the header check box when user click on the grid cell and uncheck any of the check box PinmemberViji Raj1-Jul-09 10:30 
GeneralRe: Solution: to uncheck the header check box when user click on the grid cell and uncheck any of the check box PinmemberMarpri22-Mar-12 0:55 
GeneralAppend check box after a column label PinmemberTuttiFiesta30-Jan-09 3:48 
GeneralRe: Append check box after a column label PinmemberTuttiFiesta30-Jan-09 4:23 
GeneralOne more thing needed.... PinmemberJanette M Layton1-May-08 13:49 
GeneralEvent not registered PinmemberAschmutt8-Feb-08 5:42 
GeneralRe: Event not registered PinmemberAschmutt11-Feb-08 2:15 
QuestionCurrent Cell/Row not updating Pinmemberpyerwoh18-Oct-07 11:16 
AnswerRe: Current Cell/Row not updating PinmemberDLM@bypsoft19-Oct-07 14:21 
AnswerRe: Current Cell/Row not updating Pinmemberjtxd30-Dec-11 15:23 
GeneralError Pinmembernzakir24-Sep-07 17:16 
QuestionRe: Error Pinmembernzakir24-Sep-07 17:34 
GeneralComboBox in Header Pinmemberctuzzolino18-Sep-07 8:04 
GeneralRe: ComboBox in Header PinmemberDLM@bypsoft18-Sep-07 9:22 
GeneralRe: ComboBox in Header Pinmemberctuzzolino18-Sep-07 9:25 
AnswerRe: ComboBox in Header PinmemberDLM@bypsoft19-Sep-07 2:37 
GeneralRe: ComboBox in Header Pinmemberctuzzolino27-Sep-07 2:34 
Generala little help Pinmemberpras0109198117-Sep-07 3:51 
GeneralEnhanced Class PinmemberLaurent Muller28-Aug-07 2:11 
GeneralRe: Enhanced Class PinmemberDLM@bypsoft28-Aug-07 2:38 
GeneralRe: Enhanced Class PinmemberLaurent Muller28-Aug-07 3:06 
GeneralRe: Enhanced Class PinmemberScubaSteve2000116-Nov-07 5:08 
AnswerRe: Enhanced Class PinmemberMicheleLaPietra25-Jun-08 23:19 
GeneralRe: Enhanced Class PinmemberWilliam F25-Jan-10 23:09 
GeneralRe: Enhanced Class PinmemberPravin S. Kadam25-Feb-10 2:02 
GeneralThanks! PinmemberChemically Yours24-Aug-07 3:17 

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 | Mobile
Web03 | 2.8.140926.1 | Last Updated 24 Aug 2007
Article Copyright 2007 by DLM@TD
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid