Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

DataGridViewTextBoxColumn Class

.NET Framework 4

Hosts a collection of DataGridViewTextBoxCell cells.

System.Object
  System.Windows.Forms.DataGridViewElement
    System.Windows.Forms.DataGridViewBand
      System.Windows.Forms.DataGridViewColumn
        System.Windows.Forms.DataGridViewTextBoxColumn

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
C#
C++
F#
VB
Copy 
[ToolboxBitmapAttribute(typeof(DataGridViewTextBoxColumn), "DataGridViewTextBoxColumn.bmp")]
public class DataGridViewTextBoxColumn : DataGridViewColumn

The DataGridViewTextBoxColumn type exposes the following members.

  Name Description
Public method DataGridViewTextBoxColumn Initializes a new instance of the DataGridViewTextBoxColumn class to the default state.
Top
  Name Description
Public property AutoSizeMode Gets or sets the mode by which the column automatically adjusts its width. (Inherited from DataGridViewColumn.)
Public property CellTemplate Gets or sets the template used to model cell appearance. (Overrides DataGridViewColumn.CellTemplate.)
Public property CellType Gets the run-time type of the cell template. (Inherited from DataGridViewColumn.)
Public property ContextMenuStrip Gets or sets the shortcut menu for the column. (Inherited from DataGridViewColumn.)
Public property DataGridView Gets the DataGridView control associated with this element. (Inherited from DataGridViewElement.)
Public property DataPropertyName Gets or sets the name of the data source property or database column to which the DataGridViewColumn is bound. (Inherited from DataGridViewColumn.)
Public property DefaultCellStyle Gets or sets the column's default cell style. (Inherited from DataGridViewColumn.)
Public property DefaultHeaderCellType Gets or sets the run-time type of the default header cell. (Inherited from DataGridViewBand.)
Public property Displayed Gets a value indicating whether the band is currently displayed onscreen. (Inherited from DataGridViewBand.)
Public property DisplayIndex Gets or sets the display order of the column relative to the currently displayed columns. (Inherited from DataGridViewColumn.)
Public property DividerWidth Gets or sets the width, in pixels, of the column divider. (Inherited from DataGridViewColumn.)
Public property FillWeight Gets or sets a value that represents the width of the column when it is in fill mode relative to the widths of other fill-mode columns in the control. (Inherited from DataGridViewColumn.)
Public property Frozen Gets or sets a value indicating whether a column will move when a user scrolls the DataGridView control horizontally. (Inherited from DataGridViewColumn.)
Public property HasDefaultCellStyle Gets a value indicating whether the DefaultCellStyle property has been set. (Inherited from DataGridViewBand.)
Public property HeaderCell Gets or sets the DataGridViewColumnHeaderCell that represents the column header. (Inherited from DataGridViewColumn.)
Protected property HeaderCellCore Gets or sets the header cell of the DataGridViewBand. (Inherited from DataGridViewBand.)
Public property HeaderText Gets or sets the caption text on the column's header cell. (Inherited from DataGridViewColumn.)
Public property Index Gets the relative position of the band within the DataGridView control. (Inherited from DataGridViewBand.)
Public property InheritedAutoSizeMode Gets the sizing mode in effect for the column. (Inherited from DataGridViewColumn.)
Public property InheritedStyle Gets the cell style currently applied to the column. (Inherited from DataGridViewColumn.)
Public property IsDataBound Gets a value indicating whether the column is bound to a data source. (Inherited from DataGridViewColumn.)
Protected property IsRow Gets a value indicating whether the band represents a row. (Inherited from DataGridViewBand.)
Public property MaxInputLength Gets or sets the maximum number of characters that can be entered into the text box.
Public property MinimumWidth Gets or sets the minimum width, in pixels, of the column. (Inherited from DataGridViewColumn.)
Public property Name Gets or sets the name of the column. (Inherited from DataGridViewColumn.)
Public property ReadOnly Gets or sets a value indicating whether the user can edit the column's cells. (Inherited from DataGridViewColumn.)
Public property Resizable Gets or sets a value indicating whether the column is resizable. (Inherited from DataGridViewColumn.)
Public property Selected Gets or sets a value indicating whether the band is in a selected user interface (UI) state. (Inherited from DataGridViewBand.)
Public property Site Infrastructure. Gets or sets the site of the column. (Inherited from DataGridViewColumn.)
Public property SortMode Gets or sets the sort mode for the column.
Public property State Gets the user interface (UI) state of the element. (Inherited from DataGridViewElement.)
Public property Tag Gets or sets the object that contains data to associate with the band. (Inherited from DataGridViewBand.)
Public property ToolTipText Gets or sets the text used for ToolTips. (Inherited from DataGridViewColumn.)
Public property ValueType Gets or sets the data type of the values in the column's cells. (Inherited from DataGridViewColumn.)
Public property Visible Gets or sets a value indicating whether the column is visible. (Inherited from DataGridViewColumn.)
Public property Width Gets or sets the current width of the column. (Inherited from DataGridViewColumn.)
Top
  Name Description
Public method Clone Creates an exact copy of this band. (Inherited from DataGridViewColumn.)
Public method Dispose() Releases all resources used by the DataGridViewBand. (Inherited from DataGridViewBand.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the DataGridViewBand and optionally releases the managed resources. (Inherited from DataGridViewColumn.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Releases the resources associated with the band. (Inherited from DataGridViewBand.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetPreferredWidth Calculates the ideal width of the column based on the specified criteria. (Inherited from DataGridViewColumn.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnDataGridViewChanged Called when the band is associated with a different DataGridView. (Inherited from DataGridViewBand.)
Protected method RaiseCellClick Raises the DataGridView.CellClick event. (Inherited from DataGridViewElement.)
Protected method RaiseCellContentClick Raises the DataGridView.CellContentClick event. (Inherited from DataGridViewElement.)
Protected method RaiseCellContentDoubleClick Raises the DataGridView.CellContentDoubleClick event. (Inherited from DataGridViewElement.)
Protected method RaiseCellValueChanged Raises the DataGridView.CellValueChanged event. (Inherited from DataGridViewElement.)
Protected method RaiseDataError Raises the DataGridView.DataError event. (Inherited from DataGridViewElement.)
Protected method RaiseMouseWheel Raises the Control.MouseWheel event. (Inherited from DataGridViewElement.)
Public method ToString Gets a string that describes the column. (Overrides DataGridViewColumn.ToString().)
Top
  Name Description
Public event Disposed Occurs when the DataGridViewColumn is disposed. (Inherited from DataGridViewColumn.)
Top

The DataGridViewTextBoxColumn class is a specialized type of DataGridViewColumn class used to logically host cells that enable displaying and editing of text strings. A DataGridViewTextBoxColumn has an associated DataGridViewTextBoxCell object in every DataGridViewRow that intersects it. When a DataGridViewTextBoxCell becomes activated, it supplies a DataGridViewTextBoxEditingControl control to handle user input.

The sort mode for this column type defaults to Automatic.

Notes to Inheritors

When you derive from DataGridViewTextBoxColumn 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 illustrates the use of this type.

C#
VB
Copy 

DataGridViewTextBoxColumn titleColumn =
    new DataGridViewTextBoxColumn();
titleColumn.HeaderText = "Title";
titleColumn.AutoSizeMode =
    DataGridViewAutoSizeColumnMode.AllCellsExceptHeader;

.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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ