DataGridViewCheckBoxColumn Class
TOC
Collapse the table of content
Expand the table of content

DataGridViewCheckBoxColumn Class

 

Hosts a collection of DataGridViewCheckBoxCell objects.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

System.Object
  System.Windows.Forms.DataGridViewElement
    System.Windows.Forms.DataGridViewBand
      System.Windows.Forms.DataGridViewColumn
        System.Windows.Forms.DataGridViewCheckBoxColumn

[ToolboxBitmapAttribute(typeof(DataGridViewCheckBoxColumn), "DataGridViewCheckBoxColumn.bmp")]
public class DataGridViewCheckBoxColumn : DataGridViewColumn

NameDescription
System_CAPS_pubmethodDataGridViewCheckBoxColumn()

Initializes a new instance of the DataGridViewCheckBoxColumn class to the default state.

System_CAPS_pubmethodDataGridViewCheckBoxColumn(Boolean)

Initializes a new instance of the DataGridViewCheckBoxColumn and configures it to display check boxes with two or three states.

NameDescription
System_CAPS_pubpropertyAutoSizeMode

Gets or sets the mode by which the column automatically adjusts its width.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyCellTemplate

Gets or sets the template used to create new cells.(Overrides DataGridViewColumn.CellTemplate.)

System_CAPS_pubpropertyCellType

Gets the run-time type of the cell template.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyContextMenuStrip

Gets or sets the shortcut menu for the column.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyDataGridView

Gets the DataGridView control associated with this element.(Inherited from DataGridViewElement.)

System_CAPS_pubpropertyDataPropertyName

Gets or sets the name of the data source property or database column to which the DataGridViewColumn is bound.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyDefaultCellStyle

Gets or sets the column's default cell style.(Overrides DataGridViewColumn.DefaultCellStyle.)

System_CAPS_pubpropertyDefaultHeaderCellType

Gets or sets the run-time type of the default header cell.(Inherited from DataGridViewBand.)

System_CAPS_pubpropertyDisplayed

Gets a value indicating whether the band is currently displayed onscreen. (Inherited from DataGridViewBand.)

System_CAPS_pubpropertyDisplayIndex

Gets or sets the display order of the column relative to the currently displayed columns.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyDividerWidth

Gets or sets the width, in pixels, of the column divider.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyFalseValue

Gets or sets the underlying value corresponding to a cell value of false, which appears as an unchecked box.

System_CAPS_pubpropertyFillWeight

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.)

System_CAPS_pubpropertyFlatStyle

Gets or sets the flat style appearance of the check box cells.

System_CAPS_pubpropertyFrozen

Gets or sets a value indicating whether a column will move when a user scrolls the DataGridView control horizontally.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyHasDefaultCellStyle

Gets a value indicating whether the DefaultCellStyle property has been set. (Inherited from DataGridViewBand.)

System_CAPS_pubpropertyHeaderCell

Gets or sets the DataGridViewColumnHeaderCell that represents the column header.(Inherited from DataGridViewColumn.)

System_CAPS_protpropertyHeaderCellCore

Gets or sets the header cell of the DataGridViewBand.(Inherited from DataGridViewBand.)

System_CAPS_pubpropertyHeaderText

Gets or sets the caption text on the column's header cell.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyIndeterminateValue

Gets or sets the underlying value corresponding to an indeterminate or null cell value, which appears as a disabled checkbox.

System_CAPS_pubpropertyIndex

Gets the relative position of the band within the DataGridView control.(Inherited from DataGridViewBand.)

System_CAPS_pubpropertyInheritedAutoSizeMode

Gets the sizing mode in effect for the column.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyInheritedStyle

Gets the cell style currently applied to the column.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyIsDataBound

Gets a value indicating whether the column is bound to a data source.(Inherited from DataGridViewColumn.)

System_CAPS_protpropertyIsRow

Gets a value indicating whether the band represents a row.(Inherited from DataGridViewBand.)

System_CAPS_pubpropertyMinimumWidth

Gets or sets the minimum width, in pixels, of the column.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyName

Gets or sets the name of the column.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyReadOnly

Gets or sets a value indicating whether the user can edit the column's cells.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyResizable

Gets or sets a value indicating whether the column is resizable.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertySelected

Gets or sets a value indicating whether the band is in a selected user interface (UI) state.(Inherited from DataGridViewBand.)

System_CAPS_pubpropertySite

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.)

System_CAPS_pubpropertySortMode

Gets or sets the sort mode for the column.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyState

Gets the user interface (UI) state of the element.(Inherited from DataGridViewElement.)

System_CAPS_pubpropertyTag

Gets or sets the object that contains data to associate with the band.(Inherited from DataGridViewBand.)

System_CAPS_pubpropertyThreeState

Gets or sets a value indicating whether the hosted check box cells will allow three check states rather than two.

System_CAPS_pubpropertyToolTipText

Gets or sets the text used for ToolTips.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyTrueValue

Gets or sets the underlying value corresponding to a cell value of true, which appears as a checked box.

System_CAPS_pubpropertyValueType

Gets or sets the data type of the values in the column's cells.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyVisible

Gets or sets a value indicating whether the column is visible.(Inherited from DataGridViewColumn.)

System_CAPS_pubpropertyWidth

Gets or sets the current width of the column.(Inherited from DataGridViewColumn.)

NameDescription
System_CAPS_pubmethodClone()

Creates an exact copy of this band.(Inherited from DataGridViewColumn.)

System_CAPS_pubmethodDispose()

Releases all resources used by the DataGridViewBand. (Inherited from DataGridViewBand.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the DataGridViewBand and optionally releases the managed resources.(Inherited from DataGridViewColumn.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Releases the resources associated with the band.(Inherited from DataGridViewBand.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetPreferredWidth(DataGridViewAutoSizeColumnMode, Boolean)

Calculates the ideal width of the column based on the specified criteria.(Inherited from DataGridViewColumn.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnDataGridViewChanged()

Called when the band is associated with a different DataGridView.(Inherited from DataGridViewBand.)

System_CAPS_protmethodRaiseCellClick(DataGridViewCellEventArgs)

Raises the DataGridView.CellClick event. (Inherited from DataGridViewElement.)

System_CAPS_protmethodRaiseCellContentClick(DataGridViewCellEventArgs)

Raises the DataGridView.CellContentClick event. (Inherited from DataGridViewElement.)

System_CAPS_protmethodRaiseCellContentDoubleClick(DataGridViewCellEventArgs)

Raises the DataGridView.CellContentDoubleClick event. (Inherited from DataGridViewElement.)

System_CAPS_protmethodRaiseCellValueChanged(DataGridViewCellEventArgs)

Raises the DataGridView.CellValueChanged event. (Inherited from DataGridViewElement.)

System_CAPS_protmethodRaiseDataError(DataGridViewDataErrorEventArgs)

Raises the DataGridView.DataError event. (Inherited from DataGridViewElement.)

System_CAPS_protmethodRaiseMouseWheel(MouseEventArgs)

Raises the Control.MouseWheel event. (Inherited from DataGridViewElement.)

System_CAPS_pubmethodToString()

Gets a string that describes the column.(Overrides DataGridViewColumn.ToString().)

NameDescription
System_CAPS_pubeventDisposed

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 = 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);
}

.NET Framework
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.

Return to top
Show:
© 2016 Microsoft