DataGridViewImageColumn.CellTemplate Property

Definition

Gets or sets the template used to create new cells.

C#
[System.ComponentModel.Browsable(false)]
public override System.Windows.Forms.DataGridViewCell CellTemplate { get; set; }
C#
[System.ComponentModel.Browsable(false)]
public override System.Windows.Forms.DataGridViewCell? CellTemplate { get; set; }

Property Value

A DataGridViewCell that all other cells in the column are modeled after.

Attributes

Exceptions

The set type is not compatible with type DataGridViewImageCell.

Examples

The following code example demonstrates the use of the DataGridViewColumn.CellTemplate property, which is similar to this property. This example is part of a larger example available in How to: Manipulate Columns in the Windows Forms DataGridView Control.

C#
private void CustomizeCellsInThirdColumn()
{
    int thirdColumn = 2;
    DataGridViewColumn column =
        dataGridView.Columns[thirdColumn];
    DataGridViewCell cell = new DataGridViewTextBoxCell();

    cell.Style.BackColor = Color.Wheat;
    column.CellTemplate = cell;
}

Remarks

The constructors for the DataGridViewImageColumn class initialize this property to a newly created DataGridViewImageCell.

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

Applies to

Product Versions
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9

See also