This documentation is archived and is not being maintained.

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

ExceptionCondition
InvalidCastException

The specified value when setting this property could not be cast to a DataGridViewButtonCell.

The constructor for the DataGridViewButtonColumn class initializes this property to a newly created DataGridViewButtonCell.

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 DataGridViewButtonColumn to view the sales an employee has made. A cell template is used to apply the same color to all buttons. This example is part of a larger example available in the DataGridViewComboBoxColumn class overview topic.


private void AddButtonColumn()
{
    DataGridViewButtonColumn buttons = new DataGridViewButtonColumn();
    {
        buttons.HeaderText = "Sales";
        buttons.Text = "Sales";
        buttons.UseColumnTextForButtonValue = true;
        buttons.AutoSizeMode =
            DataGridViewAutoSizeColumnMode.AllCells;
        buttons.FlatStyle = FlatStyle.Standard;
        buttons.CellTemplate.Style.BackColor = Color.Honeydew;
        buttons.DisplayIndex = 0;
    }

    DataGridView1.Columns.Add(buttons);

}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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