DataGridViewCheckBoxColumn Class
Hosts a collection of DataGridViewCheckBoxCell objects.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
System.Windows.Forms::DataGridViewElement
System.Windows.Forms::DataGridViewBand
System.Windows.Forms::DataGridViewColumn
System.Windows.Forms::DataGridViewCheckBoxColumn
| Name | Description | |
|---|---|---|
![]() | 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. |
| Name | Description | |
|---|---|---|
![]() | 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.(Overrides DataGridViewColumn::CellTemplate.) |
![]() | 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.(Overrides DataGridViewColumn::DefaultCellStyle.) |
![]() | 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 | This API supports the product infrastructure and is not intended to be used directly from your code. 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.) |
| Name | Description | |
|---|---|---|
![]() | Disposed | Occurs when the DataGridViewColumn is disposed.(Inherited from DataGridViewColumn.) |
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.
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); }
Available since 2.0
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.




