DataGridViewTextBoxColumn Class

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Hosts a collection of DataGridViewTextBoxCell cells.

public ref class DataGridViewTextBoxColumn : System::Windows::Forms::DataGridViewColumn

[System.Drawing.ToolboxBitmap(typeof(System.Windows.Forms.DataGridViewTextBoxColumn), "DataGridViewTextBoxColumn")]
public class DataGridViewTextBoxColumn : System.Windows.Forms.DataGridViewColumn

[<System.Drawing.ToolboxBitmap(typeof(System.Windows.Forms.DataGridViewTextBoxColumn), "DataGridViewTextBoxColumn")>]
type DataGridViewTextBoxColumn = class
    inherit DataGridViewColumn

Public Class DataGridViewTextBoxColumn
Inherits DataGridViewColumn

Inheritance

Object

DataGridViewElement

DataGridViewBand

DataGridViewColumn

DataGridViewTextBoxColumn

Attributes

ToolboxBitmapAttribute

Examples

The following code example illustrates the use of this type.

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

Dim titleColumn As New DataGridViewTextBoxColumn()
titleColumn.HeaderText = "Title"
titleColumn.AutoSizeMode = _
    DataGridViewAutoSizeColumnMode.AllCellsExceptHeader

Remarks

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.

Constructors

DataGridViewTextBoxColumn()

Initializes a new instance of the DataGridViewTextBoxColumn class to the default state.

Properties

AutoSizeMode	Gets or sets the mode by which the column automatically adjusts its width. (Inherited from DataGridViewColumn)
CellTemplate	Gets or sets the template used to model cell appearance.
CellType	Gets the run-time type of the cell template. (Inherited from DataGridViewColumn)
ContextMenuStrip	Gets or sets the shortcut menu for the column. (Inherited from DataGridViewColumn)
DataGridView	Gets the DataGridView control associated with this element. (Inherited from DataGridViewElement)
DataPropertyName	Gets or sets the name of the data source property or database column to which the DataGridViewColumn is bound. (Inherited from DataGridViewColumn)
DefaultCellStyle	Gets or sets the column's default cell style. (Inherited from DataGridViewColumn)
DefaultHeaderCellType	Gets or sets the run-time type of the default header cell. (Inherited from DataGridViewBand)
Displayed	Gets a value indicating whether the band is currently displayed onscreen. (Inherited from DataGridViewBand)
DisplayIndex	Gets or sets the display order of the column relative to the currently displayed columns. (Inherited from DataGridViewColumn)
DividerWidth	Gets or sets the width, in pixels, of the column divider. (Inherited from DataGridViewColumn)
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)
Frozen	Gets or sets a value indicating whether a column will move when a user scrolls the DataGridView control horizontally. (Inherited from DataGridViewColumn)
HasDefaultCellStyle	Gets a value indicating whether the DefaultCellStyle property has been set. (Inherited from DataGridViewBand)
HeaderCell	Gets or sets the DataGridViewColumnHeaderCell that represents the column header. (Inherited from DataGridViewColumn)
HeaderCellCore	Gets or sets the header cell of the DataGridViewBand. (Inherited from DataGridViewBand)
HeaderText	Gets or sets the caption text on the column's header cell. (Inherited from DataGridViewColumn)
Index	Gets the relative position of the band within the DataGridView control. (Inherited from DataGridViewBand)
InheritedAutoSizeMode	Gets the sizing mode in effect for the column. (Inherited from DataGridViewColumn)
InheritedStyle	Gets the cell style currently applied to the column. (Inherited from DataGridViewColumn)
IsDataBound	Gets a value indicating whether the column is bound to a data source. (Inherited from DataGridViewColumn)
IsRow	Gets a value indicating whether the band represents a row. (Inherited from DataGridViewBand)
MaxInputLength	Gets or sets the maximum number of characters that can be entered into the text box.
MinimumWidth	Gets or sets the minimum width, in pixels, of the column. (Inherited from DataGridViewColumn)
Name	Gets or sets the name of the column. (Inherited from DataGridViewColumn)
ReadOnly	Gets or sets a value indicating whether the user can edit the column's cells. (Inherited from DataGridViewColumn)
Resizable	Gets or sets a value indicating whether the column is resizable. (Inherited from DataGridViewColumn)
Selected	Gets or sets a value indicating whether the band is in a selected user interface (UI) state. (Inherited from DataGridViewBand)
Site	Gets or sets the site of the column. (Inherited from DataGridViewColumn)
SortMode	Gets or sets the sort mode for the column.
State	Gets the user interface (UI) state of the element. (Inherited from DataGridViewElement)
Tag	Gets or sets the object that contains data to associate with the band. (Inherited from DataGridViewBand)
ToolTipText	Gets or sets the text used for ToolTips. (Inherited from DataGridViewColumn)
ValueType	Gets or sets the data type of the values in the column's cells. (Inherited from DataGridViewColumn)
Visible	Gets or sets a value indicating whether the column is visible. (Inherited from DataGridViewColumn)
Width	Gets or sets the current width of the column. (Inherited from DataGridViewColumn)

Methods

Clone()	Creates an exact copy of this band. (Inherited from DataGridViewColumn)
Dispose()	Releases all resources used by the DataGridViewBand. (Inherited from DataGridViewBand)
Dispose(Boolean)	Releases the unmanaged resources used by the DataGridViewBand and optionally releases the managed resources. (Inherited from DataGridViewColumn)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetPreferredWidth(DataGridViewAutoSizeColumnMode, Boolean)	Calculates the ideal width of the column based on the specified criteria. (Inherited from DataGridViewColumn)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDataGridViewChanged()	Called when the band is associated with a different DataGridView. (Inherited from DataGridViewBand)
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)
ToString()	Gets a string that describes the column.

Events

Disposed

Occurs when the DataGridViewColumn is disposed. (Inherited from DataGridViewColumn)

See also

• DataGridView
• DataGridViewColumn
• DataGridViewRow
• DataGridViewTextBoxCell
• DataGridViewTextBoxEditingControl
• SortMode