DataGridViewCheckBoxColumn::CellTemplate Property
Gets or sets the template used to create new cells.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
public: [BrowsableAttribute(false)] property DataGridViewCell^ CellTemplate { virtual DataGridViewCell^ get() override; virtual void set(DataGridViewCell^ value) override; }
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.
| Exception | Condition |
|---|---|
| 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 |
|---|
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 = 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
