DataGridViewCheckBoxColumn Class

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

DataGridViewCheckBoxColumn.cs

Hosts a collection of DataGridViewCheckBoxCell objects.

public ref class DataGridViewCheckBoxColumn : System::Windows::Forms::DataGridViewColumn

[System.Drawing.ToolboxBitmap(typeof(System.Windows.Forms.DataGridViewCheckBoxColumn), "DataGridViewCheckBoxColumn")]
public class DataGridViewCheckBoxColumn : System.Windows.Forms.DataGridViewColumn

[<System.Drawing.ToolboxBitmap(typeof(System.Windows.Forms.DataGridViewCheckBoxColumn), "DataGridViewCheckBoxColumn")>]
type DataGridViewCheckBoxColumn = class
    inherit DataGridViewColumn

Public Class DataGridViewCheckBoxColumn
Inherits DataGridViewColumn

Inheritance

Object

DataGridViewElement

DataGridViewBand

DataGridViewColumn

DataGridViewCheckBoxColumn

Attributes

ToolboxBitmapAttribute

Examples

The following code example demonstrates how to use a DataGridViewCheckBoxColumn to mark which employees are out of the office. This example is part of a larger example available in the DataGridViewComboBoxColumn class overview topic.

private:
    void AddOutOfOfficeColumn()
    {
        DataGridViewCheckBoxColumn^ column = gcnew DataGridViewCheckBoxColumn();
        {
            column->HeaderText = ColumnName::OutOfOffice.ToString();
            column->Name = ColumnName::OutOfOffice.ToString();
            column->AutoSizeMode = 
                DataGridViewAutoSizeColumnMode::DisplayedCells;
            column->FlatStyle = FlatStyle::Standard;
            column->ThreeState = true;
            column->CellTemplate = gcnew DataGridViewCheckBoxCell();
            column->CellTemplate->Style->BackColor = Color::Beige;
        }

        DataGridView1->Columns->Insert(0, column);
    }

private void AddOutOfOfficeColumn()
{
    DataGridViewCheckBoxColumn column = new DataGridViewCheckBoxColumn();
    {
        column.HeaderText = ColumnName.OutOfOffice.ToString();
        column.Name = ColumnName.OutOfOffice.ToString();
        column.AutoSizeMode = 
            DataGridViewAutoSizeColumnMode.DisplayedCells;
        column.FlatStyle = FlatStyle.Standard;
        column.ThreeState = true;
        column.CellTemplate = new DataGridViewCheckBoxCell();
        column.CellTemplate.Style.BackColor = Color.Beige;
    }

    DataGridView1.Columns.Insert(0, column);
}

Private Sub AddOutOfOfficeColumn()
    Dim column As New DataGridViewCheckBoxColumn()
    With column
        .HeaderText = ColumnName.OutOfOffice.ToString()
        .Name = ColumnName.OutOfOffice.ToString()
        .AutoSizeMode = DataGridViewAutoSizeColumnMode.DisplayedCells
        .FlatStyle = FlatStyle.Standard
        .CellTemplate = New DataGridViewCheckBoxCell()
        .CellTemplate.Style.BackColor = Color.Beige
    End With

    DataGridView1.Columns.Insert(0, column)
End Sub

Remarks

The DataGridViewCheckBoxColumn class is a specialized type of the DataGridViewColumn class used to logically host cells that indicate binary state. A DataGridViewCheckBoxColumn has an associated DataGridViewCheckBoxCell in every DataGridViewRow that intersects it. Each cell supplies a user interface (UI) that is similar to a CheckBox control.

The default sort mode for this column type is NotSortable.

Typically, check box cell values are intended either for storage, like any other data, or for performing bulk operations. If you want to respond immediately when users click a check box cell, you can handle the DataGridView.CellContentClick event, but this event occurs before the cell value is updated. If you need the new value at the time of the click, one option is to calculate what the expected value will be based on the current value. Another approach is to commit the change immediately, and handle the DataGridView.CellValueChanged event to respond to it. To commit the change when the cell is clicked, you must handle the DataGridView.CurrentCellDirtyStateChanged event. In the handler, if the current cell is a check box cell, call the DataGridView.CommitEdit method and pass in the Commit value.

Notes to Inheritors

When you derive from DataGridViewCheckBoxColumn and add new properties to the derived class, be sure to override the Clone() method to copy the new properties during cloning operations. You should also call the base class's Clone() method so that the properties of the base class are copied to the new cell.

Constructors

DataGridViewCheckBoxColumn()	Initializes a new instance of the DataGridViewCheckBoxColumn class to the default state.
DataGridViewCheckBoxColumn(Boolean)	Initializes a new instance of the DataGridViewCheckBoxColumn and configures it to display check boxes with two or three states.

Properties

AutoSizeMode	Gets or sets the mode by which the column automatically adjusts its width. (Inherited from DataGridViewColumn)
CellTemplate	Gets or sets the template used to create new cells.
CellType	Gets the run-time type of the cell template. (Inherited from DataGridViewColumn)
ContextMenuStrip	Gets or sets the shortcut menu for the column. (Inherited from DataGridViewColumn)
DataGridView	Gets the DataGridView control associated with this element. (Inherited from DataGridViewElement)
DataPropertyName	Gets or sets the name of the data source property or database column to which the DataGridViewColumn is bound. (Inherited from DataGridViewColumn)
DefaultCellStyle	Gets or sets the column's default cell style.
DefaultHeaderCellType	Gets or sets the run-time type of the default header cell. (Inherited from DataGridViewBand)
Displayed	Gets a value indicating whether the band is currently displayed onscreen. (Inherited from DataGridViewBand)
DisplayIndex	Gets or sets the display order of the column relative to the currently displayed columns. (Inherited from DataGridViewColumn)
DividerWidth	Gets or sets the width, in pixels, of the column divider. (Inherited from DataGridViewColumn)
FalseValue	Gets or sets the underlying value corresponding to a cell value of false, which appears as an unchecked box.
FillWeight	Gets or sets a value that represents the width of the column when it is in fill mode relative to the widths of other fill-mode columns in the control. (Inherited from DataGridViewColumn)
FlatStyle	Gets or sets the flat style appearance of the check box cells.
Frozen	Gets or sets a value indicating whether a column will move when a user scrolls the DataGridView control horizontally. (Inherited from DataGridViewColumn)
HasDefaultCellStyle	Gets a value indicating whether the DefaultCellStyle property has been set. (Inherited from DataGridViewBand)
HeaderCell	Gets or sets the DataGridViewColumnHeaderCell that represents the column header. (Inherited from DataGridViewColumn)
HeaderCellCore	Gets or sets the header cell of the DataGridViewBand. (Inherited from DataGridViewBand)
HeaderText	Gets or sets the caption text on the column's header cell. (Inherited from DataGridViewColumn)
IndeterminateValue	Gets or sets the underlying value corresponding to an indeterminate or null cell value, which appears as a disabled checkbox.
Index	Gets the relative position of the band within the DataGridView control. (Inherited from DataGridViewBand)
InheritedAutoSizeMode	Gets the sizing mode in effect for the column. (Inherited from DataGridViewColumn)
InheritedStyle	Gets the cell style currently applied to the column. (Inherited from DataGridViewColumn)
IsDataBound	Gets a value indicating whether the column is bound to a data source. (Inherited from DataGridViewColumn)
IsRow	Gets a value indicating whether the band represents a row. (Inherited from DataGridViewBand)
MinimumWidth	Gets or sets the minimum width, in pixels, of the column. (Inherited from DataGridViewColumn)
Name	Gets or sets the name of the column. (Inherited from DataGridViewColumn)
ReadOnly	Gets or sets a value indicating whether the user can edit the column's cells. (Inherited from DataGridViewColumn)
Resizable	Gets or sets a value indicating whether the column is resizable. (Inherited from DataGridViewColumn)
Selected	Gets or sets a value indicating whether the band is in a selected user interface (UI) state. (Inherited from DataGridViewBand)
Site	Gets or sets the site of the column. (Inherited from DataGridViewColumn)
SortMode	Gets or sets the sort mode for the column. (Inherited from DataGridViewColumn)
State	Gets the user interface (UI) state of the element. (Inherited from DataGridViewElement)
Tag	Gets or sets the object that contains data to associate with the band. (Inherited from DataGridViewBand)
ThreeState	Gets or sets a value indicating whether the hosted check box cells will allow three check states rather than two.
ToolTipText	Gets or sets the text used for ToolTips. (Inherited from DataGridViewColumn)
TrueValue	Gets or sets the underlying value corresponding to a cell value of true, which appears as a checked box.
ValueType	Gets or sets the data type of the values in the column's cells. (Inherited from DataGridViewColumn)
Visible	Gets or sets a value indicating whether the column is visible. (Inherited from DataGridViewColumn)
Width	Gets or sets the current width of the column. (Inherited from DataGridViewColumn)

Methods

Clone()	Creates an exact copy of this band. (Inherited from DataGridViewColumn)
Dispose()	Releases all resources used by the DataGridViewBand. (Inherited from DataGridViewBand)
Dispose(Boolean)	Releases the unmanaged resources used by the DataGridViewBand and optionally releases the managed resources. (Inherited from DataGridViewColumn)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetPreferredWidth(DataGridViewAutoSizeColumnMode, Boolean)	Calculates the ideal width of the column based on the specified criteria. (Inherited from DataGridViewColumn)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDataGridViewChanged()	Called when the band is associated with a different DataGridView. (Inherited from DataGridViewBand)
RaiseCellClick(DataGridViewCellEventArgs)	Raises the CellClick event. (Inherited from DataGridViewElement)
RaiseCellContentClick(DataGridViewCellEventArgs)	Raises the CellContentClick event. (Inherited from DataGridViewElement)
RaiseCellContentDoubleClick(DataGridViewCellEventArgs)	Raises the CellContentDoubleClick event. (Inherited from DataGridViewElement)
RaiseCellValueChanged(DataGridViewCellEventArgs)	Raises the CellValueChanged event. (Inherited from DataGridViewElement)
RaiseDataError(DataGridViewDataErrorEventArgs)	Raises the DataError event. (Inherited from DataGridViewElement)
RaiseMouseWheel(MouseEventArgs)	Raises the MouseWheel event. (Inherited from DataGridViewElement)
ToString()	Gets a string that describes the column.

Events

Disposed

Occurs when the DataGridViewColumn is disposed. (Inherited from DataGridViewColumn)

See also

• DataGridView
• DataGridViewColumn
• DataGridViewRow
• DataGridViewCheckBoxCell
• CheckBox
• SortMode
• CellClick
• CellValueChanged
• CurrentCellDirtyStateChanged
• CommitEdit(DataGridViewDataErrorContexts)