This documentation is archived and is not being maintained.

DataGridViewColumn.CellTemplate Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the template used to create new cells.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public virtual DataGridViewCell CellTemplate { get; set; }
/** @property */
public DataGridViewCell get_CellTemplate ()

/** @property */
public void set_CellTemplate (DataGridViewCell value)

public function get CellTemplate () : DataGridViewCell

public function set CellTemplate (value : DataGridViewCell)

Property Value

A DataGridViewCell that all other cells in the column are modeled after. The default is a null reference (Nothing in Visual Basic).

The constructors for the DataGridViewColumn class initialize this property. The default constructor sets the property to a null reference (Nothing in Visual Basic); the other constructor copies the cell template from its parameter.

NoteNote

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 DataGridViewCell as a template for a DataGridViewColumn. Style changes made to any cell in the column affect all of the column's cells. This code example is part of a larger example provided for the DataGridViewColumn class.

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

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

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0
Show: