DataGridViewTextBoxCell Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Displays editable text information in a DataGridView control.
public ref class DataGridViewTextBoxCell : System::Windows::Forms::DataGridViewCellpublic class DataGridViewTextBoxCell : System.Windows.Forms.DataGridViewCelltype DataGridViewTextBoxCell = class
inherit DataGridViewCellPublic Class DataGridViewTextBoxCell
Inherits DataGridViewCell- Inheritance
Examples
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.
void CustomizeCellsInThirdColumn()
{
int thirdColumn = 2;
DataGridViewColumn^ column = dataGridView->Columns[ thirdColumn ];
DataGridViewCell^ cell = gcnew DataGridViewTextBoxCell;
cell->Style->BackColor = Color::Wheat;
column->CellTemplate = cell;
}
private void CustomizeCellsInThirdColumn()
{
int thirdColumn = 2;
DataGridViewColumn column =
dataGridView.Columns[thirdColumn];
DataGridViewCell cell = new DataGridViewTextBoxCell();
cell.Style.BackColor = Color.Wheat;
column.CellTemplate = cell;
}
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
Remarks
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.
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.
Constructors
| DataGridViewTextBoxCell() |
Initializes a new instance of the DataGridViewTextBoxCell class. |
Properties
| AccessibilityObject |
Gets the DataGridViewCell.DataGridViewCellAccessibleObject assigned to the DataGridViewCell. (Inherited from DataGridViewCell) |
| ColumnIndex |
Gets the column index for this cell. (Inherited from DataGridViewCell) |
| ContentBounds |
Gets the bounding rectangle that encloses the cell's content area. (Inherited from DataGridViewCell) |
| ContextMenuStrip |
Gets or sets the shortcut menu associated with the cell. (Inherited from DataGridViewCell) |
| DataGridView |
Gets the DataGridView control associated with this element. (Inherited from DataGridViewElement) |
| DefaultNewRowValue |
Gets the default value for a cell in the row for new records. (Inherited from DataGridViewCell) |
| Displayed |
Gets a value that indicates whether the cell is currently displayed on-screen. (Inherited from DataGridViewCell) |
| EditedFormattedValue |
Gets the current, formatted value of the cell, regardless of whether the cell is in edit mode and the value has not been committed. (Inherited from DataGridViewCell) |
| EditType |
Gets the type of the cell's hosted editing control. (Inherited from DataGridViewCell) |
| ErrorIconBounds |
Gets the bounds of the error icon for the cell. (Inherited from DataGridViewCell) |
| ErrorText |
Gets or sets the text describing an error condition associated with the cell. (Inherited from DataGridViewCell) |
| FormattedValue |
Gets the value of the cell as formatted for display. (Inherited from DataGridViewCell) |
| FormattedValueType |
Gets the type of the formatted value associated with the cell. |
| Frozen |
Gets a value indicating whether the cell is frozen. (Inherited from DataGridViewCell) |
| HasStyle |
Gets a value indicating whether the Style property has been set. (Inherited from DataGridViewCell) |
| InheritedState |
Gets the current state of the cell as inherited from the state of its row and column. (Inherited from DataGridViewCell) |
| InheritedStyle |
Gets the style currently applied to the cell. (Inherited from DataGridViewCell) |
| IsInEditMode |
Gets a value indicating whether this cell is currently being edited. (Inherited from DataGridViewCell) |
| MaxInputLength |
Gets or sets the maximum number of characters that can be entered into the text box. |
| OwningColumn |
Gets the column that contains this cell. (Inherited from DataGridViewCell) |
| OwningRow |
Gets the row that contains this cell. (Inherited from DataGridViewCell) |
| PreferredSize |
Gets the size, in pixels, of a rectangular area into which the cell can fit. (Inherited from DataGridViewCell) |
| ReadOnly |
Gets or sets a value indicating whether the cell's data can be edited. (Inherited from DataGridViewCell) |
| Resizable |
Gets a value indicating whether the cell can be resized. (Inherited from DataGridViewCell) |
| RowIndex |
Gets the index of the cell's parent row. (Inherited from DataGridViewCell) |
| Selected |
Gets or sets a value indicating whether the cell has been selected. (Inherited from DataGridViewCell) |
| Size |
Gets the size of the cell. (Inherited from DataGridViewCell) |
| State |
Gets the user interface (UI) state of the element. (Inherited from DataGridViewElement) |
| Style |
Gets or sets the style for the cell. (Inherited from DataGridViewCell) |
| Tag |
Gets or sets the object that contains supplemental data about the cell. (Inherited from DataGridViewCell) |
| ToolTipText |
Gets or sets the ToolTip text associated with this cell. (Inherited from DataGridViewCell) |
| Value |
Gets or sets the value associated with this cell. (Inherited from DataGridViewCell) |
| ValueType |
Gets or sets the data type of the values in the cell. |
| Visible |
Gets a value indicating whether the cell is in a row or column that has been hidden. (Inherited from DataGridViewCell) |
Methods
| AdjustCellBorderStyle(DataGridViewAdvancedBorderStyle, DataGridViewAdvancedBorderStyle, Boolean, Boolean, Boolean, Boolean) |
Modifies the input cell border style according to the specified criteria. (Inherited from DataGridViewCell) |
| BorderWidths(DataGridViewAdvancedBorderStyle) |
Returns a Rectangle that represents the widths of all the cell margins. (Inherited from DataGridViewCell) |
| ClickUnsharesRow(DataGridViewCellEventArgs) |
Indicates whether the cell's row will be unshared when the cell is clicked. (Inherited from DataGridViewCell) |
| Clone() |
Creates an exact copy of this cell. |
| ContentClickUnsharesRow(DataGridViewCellEventArgs) |
Indicates whether the cell's row will be unshared when the cell's content is clicked. (Inherited from DataGridViewCell) |
| ContentDoubleClickUnsharesRow(DataGridViewCellEventArgs) |
Indicates whether the cell's row will be unshared when the cell's content is double-clicked. (Inherited from DataGridViewCell) |
| CreateAccessibilityInstance() |
Creates a new AccessibleObject for this DataGridViewTextBoxCell instance. |
| CreateAccessibilityInstance() |
Creates a new accessible object for the DataGridViewCell. (Inherited from DataGridViewCell) |
| DetachEditingControl() |
Removes the cell's editing control from the DataGridView. |
| Dispose() |
Releases all resources used by the DataGridViewCell. (Inherited from DataGridViewCell) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the DataGridViewCell and optionally releases the managed resources. (Inherited from DataGridViewCell) |
| DoubleClickUnsharesRow(DataGridViewCellEventArgs) |
Indicates whether the cell's row will be unshared when the cell is double-clicked. (Inherited from DataGridViewCell) |
| EnterUnsharesRow(Int32, Boolean) |
Indicates whether the parent row will be unshared when the focus moves to the cell. (Inherited from DataGridViewCell) |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetClipboardContent(Int32, Boolean, Boolean, Boolean, Boolean, String) |
Retrieves the formatted value of the cell to copy to the Clipboard. (Inherited from DataGridViewCell) |
| GetContentBounds(Graphics, DataGridViewCellStyle, Int32) |
Returns the bounding rectangle that encloses the cell's content area, which is calculated using the specified Graphics and cell style. |
| GetContentBounds(Int32) |
Returns the bounding rectangle that encloses the cell's content area using a default Graphics and cell style currently in effect for the cell. (Inherited from DataGridViewCell) |
| GetEditedFormattedValue(Int32, DataGridViewDataErrorContexts) |
Returns the current, formatted value of the cell, regardless of whether the cell is in edit mode and the value has not been committed. (Inherited from DataGridViewCell) |
| GetErrorIconBounds(Graphics, DataGridViewCellStyle, Int32) |
Returns the bounding rectangle that encloses the cell's error icon, if one is displayed. |
| GetErrorText(Int32) |
Returns a string that represents the error for the cell. (Inherited from DataGridViewCell) |
| GetFormattedValue(Object, Int32, DataGridViewCellStyle, TypeConverter, TypeConverter, DataGridViewDataErrorContexts) |
Gets the value of the cell as formatted for display. (Inherited from DataGridViewCell) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetInheritedContextMenuStrip(Int32) |
Gets the inherited shortcut menu for the current cell. (Inherited from DataGridViewCell) |
| GetInheritedState(Int32) |
Returns a value indicating the current state of the cell as inherited from the state of its row and column. (Inherited from DataGridViewCell) |
| GetInheritedStyle(DataGridViewCellStyle, Int32, Boolean) |
Gets the style applied to the cell. (Inherited from DataGridViewCell) |
| GetPreferredSize(Graphics, DataGridViewCellStyle, Int32, Size) |
Calculates the preferred size, in pixels, of the cell. |
| GetSize(Int32) |
Gets the size of the cell. (Inherited from DataGridViewCell) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| GetValue(Int32) |
Gets the value of the cell. (Inherited from DataGridViewCell) |
| InitializeEditingControl(Int32, Object, DataGridViewCellStyle) |
Attaches and initializes the hosted editing control. |
| KeyDownUnsharesRow(KeyEventArgs, Int32) |
Indicates whether the parent row is unshared if the user presses a key while the focus is on the cell. (Inherited from DataGridViewCell) |
| KeyEntersEditMode(KeyEventArgs) |
Determines if edit mode should be started based on the given key. |
| KeyPressUnsharesRow(KeyPressEventArgs, Int32) |
Indicates whether a row will be unshared if a key is pressed while a cell in the row has focus. (Inherited from DataGridViewCell) |
| KeyUpUnsharesRow(KeyEventArgs, Int32) |
Indicates whether the parent row is unshared when the user releases a key while the focus is on the cell. (Inherited from DataGridViewCell) |
| LeaveUnsharesRow(Int32, Boolean) |
Indicates whether a row will be unshared when the focus leaves a cell in the row. (Inherited from DataGridViewCell) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| MouseClickUnsharesRow(DataGridViewCellMouseEventArgs) |
Indicates whether a row will be unshared if the user clicks a mouse button while the pointer is on a cell in the row. (Inherited from DataGridViewCell) |
| MouseDoubleClickUnsharesRow(DataGridViewCellMouseEventArgs) |
Indicates whether a row will be unshared if the user double-clicks a cell in the row. (Inherited from DataGridViewCell) |
| MouseDownUnsharesRow(DataGridViewCellMouseEventArgs) |
Indicates whether a row will be unshared when the user holds down a mouse button while the pointer is on a cell in the row. (Inherited from DataGridViewCell) |
| MouseEnterUnsharesRow(Int32) |
Indicates whether a row will be unshared when the mouse pointer moves over a cell in the row. (Inherited from DataGridViewCell) |
| MouseLeaveUnsharesRow(Int32) |
Indicates whether a row will be unshared when the mouse pointer leaves the row. (Inherited from DataGridViewCell) |
| MouseMoveUnsharesRow(DataGridViewCellMouseEventArgs) |
Indicates whether a row will be unshared when the mouse pointer moves over a cell in the row. (Inherited from DataGridViewCell) |
| MouseUpUnsharesRow(DataGridViewCellMouseEventArgs) |
Indicates whether a row will be unshared when the user releases a mouse button while the pointer is on a cell in the row. (Inherited from DataGridViewCell) |
| OnClick(DataGridViewCellEventArgs) |
Called when the cell is clicked. (Inherited from DataGridViewCell) |
| OnContentClick(DataGridViewCellEventArgs) |
Called when the cell's contents are clicked. (Inherited from DataGridViewCell) |
| OnContentDoubleClick(DataGridViewCellEventArgs) |
Called when the cell's contents are double-clicked. (Inherited from DataGridViewCell) |
| OnDataGridViewChanged() |
Called when the DataGridView property of the cell changes. (Inherited from DataGridViewCell) |
| OnDoubleClick(DataGridViewCellEventArgs) |
Called when the cell is double-clicked. (Inherited from DataGridViewCell) |
| OnEnter(Int32, Boolean) |
Called by DataGridView when the selection cursor moves onto a cell. |
| OnKeyDown(KeyEventArgs, Int32) |
Called when a character key is pressed while the focus is on a cell. (Inherited from DataGridViewCell) |
| OnKeyPress(KeyPressEventArgs, Int32) |
Called when a key is pressed while the focus is on a cell. (Inherited from DataGridViewCell) |
| OnKeyUp(KeyEventArgs, Int32) |
Called when a character key is released while the focus is on a cell. (Inherited from DataGridViewCell) |
| OnLeave(Int32, Boolean) |
Called by the DataGridView when the mouse leaves a cell. |
| OnMouseClick(DataGridViewCellMouseEventArgs) |
Called by DataGridView when the mouse leaves a cell. |
| OnMouseDoubleClick(DataGridViewCellMouseEventArgs) |
Called when the user double-clicks a mouse button while the pointer is on a cell. (Inherited from DataGridViewCell) |
| OnMouseDown(DataGridViewCellMouseEventArgs) |
Called when the user holds down a mouse button while the pointer is on a cell. (Inherited from DataGridViewCell) |
| OnMouseEnter(Int32) |
Called when the mouse pointer moves over a cell. (Inherited from DataGridViewCell) |
| OnMouseLeave(Int32) |
Called when the mouse pointer leaves the cell. (Inherited from DataGridViewCell) |
| OnMouseMove(DataGridViewCellMouseEventArgs) |
Called when the mouse pointer moves within a cell. (Inherited from DataGridViewCell) |
| OnMouseUp(DataGridViewCellMouseEventArgs) |
Called when the user releases a mouse button while the pointer is on a cell. (Inherited from DataGridViewCell) |
| Paint(Graphics, Rectangle, Rectangle, Int32, DataGridViewElementStates, Object, Object, String, DataGridViewCellStyle, DataGridViewAdvancedBorderStyle, DataGridViewPaintParts) |
Paints the current DataGridViewCell. |
| PaintBorder(Graphics, Rectangle, Rectangle, DataGridViewCellStyle, DataGridViewAdvancedBorderStyle) |
Paints the border of the current DataGridViewCell. (Inherited from DataGridViewCell) |
| PaintErrorIcon(Graphics, Rectangle, Rectangle, String) |
Paints the error icon of the current DataGridViewCell. (Inherited from DataGridViewCell) |
| ParseFormattedValue(Object, DataGridViewCellStyle, TypeConverter, TypeConverter) |
Converts a value formatted for display to an actual cell value. (Inherited from DataGridViewCell) |
| PositionEditingControl(Boolean, Boolean, Rectangle, Rectangle, DataGridViewCellStyle, Boolean, Boolean, Boolean, Boolean) |
Sets the location and size of the editing control hosted by a cell in the DataGridView control. |
| PositionEditingPanel(Rectangle, Rectangle, DataGridViewCellStyle, Boolean, Boolean, Boolean, Boolean) |
Sets the location and size of the editing panel hosted by the cell, and returns the normal bounds of the editing control within the editing panel. (Inherited from DataGridViewCell) |
| RaiseCellClick(DataGridViewCellEventArgs) |
Raises the CellClick event. (Inherited from DataGridViewElement) |
| RaiseCellContentClick(DataGridViewCellEventArgs) |
Raises the CellContentClick event. (Inherited from DataGridViewElement) |
| RaiseCellContentDoubleClick(DataGridViewCellEventArgs) |
Raises the CellContentDoubleClick event. (Inherited from DataGridViewElement) |
| RaiseCellValueChanged(DataGridViewCellEventArgs) |
Raises the CellValueChanged event. (Inherited from DataGridViewElement) |
| RaiseDataError(DataGridViewDataErrorEventArgs) |
Raises the DataError event. (Inherited from DataGridViewElement) |
| RaiseMouseWheel(MouseEventArgs) |
Raises the MouseWheel event. (Inherited from DataGridViewElement) |
| SetValue(Int32, Object) |
Sets the value of the cell. (Inherited from DataGridViewCell) |
| ToString() |
Returns a string that describes the current object. |
