Export (0) Print
Expand All

DataGridViewTextBoxCell Class

Displays editable text information in a DataGridView control.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

'Declaration
Public Class DataGridViewTextBoxCell _
	Inherits DataGridViewCell
'Usage
Dim instance As DataGridViewTextBoxCell

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. To model the cells within a column after an existing DataGridViewTextBoxCell, set the column's CellTemplate property to that cell. By default, the CellTemplate is initialized to a new DataGridViewTextBoxCell.

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.

Notes to Inheritors:

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 Sub CustomizeCellsInThirdColumn()

    Dim thirdColumn As Integer = 2
    Dim column As DataGridViewColumn = _
        dataGridView.Columns(thirdColumn)
    Dim cell As DataGridViewCell = _
        New DataGridViewTextBoxCell()

    cell.Style.BackColor = Color.Wheat
    column.CellTemplate = cell
End Sub

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft