DataGridViewTextBoxCell Class

The DataGridViewTextBoxCell class is a specialized type of DataGridViewCell used to display a single string of editable text-based information. The currently selected DataGridViewTextBoxCell hosts a DataGridViewTextBoxEditingControl control in which the user can edit the cell's value (assuming the ReadOnly property of the DataGridViewTextBoxCell is set to false).

The DataGridViewTextBoxColumn is the column type specialized to hold cells of this type. By default, the DataGridViewTextBoxColumn.CellTemplate is initialized to a new DataGridViewTextBoxCell. To pattern the cells within a column after an existing DataGridViewTextBoxCell, set the column's CellTemplate property to the cell to use as a pattern.

The cell-related properties of the column are wrappers for the similarly-named properties of the template cell. Changing the property values of the template cell will affect only cells based on the template that are added after the change. Changing the cell-related property values of the column, however, will update the template cell and all other cells in the column, and refresh the column display if necessary.

When you derive from DataGridViewTextBoxCell and add new properties to the derived class, be sure to override the Clone method to copy the new properties during cloning operations. You should also call the base class's Clone method so that the properties of the base class are copied to the new cell.

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;
}

.NET Framework

.NET Framework Client Profile

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

Reference