Export (0) Print
Expand All

DataGridViewCheckBoxColumn.CellTemplate Property

Gets or sets the template used to create new cells.

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

[BrowsableAttribute(false)]
public override DataGridViewCell CellTemplate { get; set; }

Property Value

Type: System.Windows.Forms.DataGridViewCell
A DataGridViewCell that all other cells in the column are modeled after. The default value is a new DataGridViewCheckBoxCell instance.

ExceptionCondition
InvalidCastException

The property is set to a value that is not of type DataGridViewCheckBoxCell.

The constructors for the DataGridViewCheckBoxColumn class initialize this property to a newly created DataGridViewCheckBoxCell.

Caution noteCaution

Changing the properties of the cell template will not immediately affect the user interface (UI) of the column's existing cells. These changes are only apparent after the column is regenerated (for example, by sorting the column or through a call to the DataGridView.InvalidateColumn method).

The following code example demonstrates how to use a DataGridViewCheckBoxColumn to mark which employees are out of the office. The cell template is used to apply the same color to all cells in the check box column. 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

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft