Export (0) Print
Expand All

DataGridViewColumn Class

Represents a column in a DataGridView control.

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

type DataGridViewColumn =  
    class 
        inherit DataGridViewBand 
        interface IComponent 
        interface IDisposable 
    end

The DataGridViewColumn type exposes the following members.

  NameDescription
Public methodDataGridViewColumn()Initializes a new instance of the DataGridViewColumn class to the default state.
Public methodDataGridViewColumn(DataGridViewCell)Initializes a new instance of the DataGridViewColumn class using an existing DataGridViewCell as a template.
Top

  NameDescription
Public propertyAutoSizeModeGets or sets the mode by which the column automatically adjusts its width.
Public propertyCellTemplateGets or sets the template used to create new cells.
Public propertyCellTypeGets the run-time type of the cell template.
Public propertyContextMenuStripGets or sets the shortcut menu for the column. (Overrides DataGridViewBand.ContextMenuStrip.)
Public propertyDataGridViewGets the DataGridView control associated with this element. (Inherited from DataGridViewElement.)
Public propertyDataPropertyNameGets or sets the name of the data source property or database column to which the DataGridViewColumn is bound.
Public propertyDefaultCellStyleGets or sets the column's default cell style. (Overrides DataGridViewBand.DefaultCellStyle.)
Public propertyDefaultHeaderCellTypeGets or sets the run-time type of the default header cell. (Inherited from DataGridViewBand.)
Public propertyDisplayedGets a value indicating whether the band is currently displayed onscreen. (Inherited from DataGridViewBand.)
Public propertyDisplayIndexGets or sets the display order of the column relative to the currently displayed columns.
Public propertyDividerWidthGets or sets the width, in pixels, of the column divider.
Public propertyFillWeightGets 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.
Public propertyFrozenGets or sets a value indicating whether a column will move when a user scrolls the DataGridView control horizontally. (Overrides DataGridViewBand.Frozen.)
Public propertyHasDefaultCellStyleGets a value indicating whether the DefaultCellStyle property has been set. (Inherited from DataGridViewBand.)
Public propertyHeaderCellGets or sets the DataGridViewColumnHeaderCell that represents the column header.
Protected propertyHeaderCellCoreGets or sets the header cell of the DataGridViewBand. (Inherited from DataGridViewBand.)
Public propertyHeaderTextGets or sets the caption text on the column's header cell.
Public propertyIndexGets the relative position of the band within the DataGridView control. (Inherited from DataGridViewBand.)
Public propertyInheritedAutoSizeModeGets the sizing mode in effect for the column.
Public propertyInheritedStyleGets the cell style currently applied to the column. (Overrides DataGridViewBand.InheritedStyle.)
Public propertyIsDataBoundGets a value indicating whether the column is bound to a data source.
Protected propertyIsRowGets a value indicating whether the band represents a row. (Inherited from DataGridViewBand.)
Public propertyMinimumWidthGets or sets the minimum width, in pixels, of the column.
Public propertyNameGets or sets the name of the column.
Public propertyReadOnlyGets or sets a value indicating whether the user can edit the column's cells. (Overrides DataGridViewBand.ReadOnly.)
Public propertyResizableGets or sets a value indicating whether the column is resizable. (Overrides DataGridViewBand.Resizable.)
Public propertySelectedGets or sets a value indicating whether the band is in a selected user interface (UI) state. (Inherited from DataGridViewBand.)
Public propertySiteInfrastructure. Gets or sets the site of the column.
Public propertySortModeGets or sets the sort mode for the column.
Public propertyStateGets the user interface (UI) state of the element. (Inherited from DataGridViewElement.)
Public propertyTagGets or sets the object that contains data to associate with the band. (Inherited from DataGridViewBand.)
Public propertyToolTipTextGets or sets the text used for ToolTips.
Public propertyValueTypeGets or sets the data type of the values in the column's cells.
Public propertyVisibleGets or sets a value indicating whether the column is visible. (Overrides DataGridViewBand.Visible.)
Public propertyWidthGets or sets the current width of the column.
Top

  NameDescription
Public methodCloneCreates an exact copy of this band. (Overrides DataGridViewBand.Clone().)
Public methodDispose()Releases all resources used by the DataGridViewBand. (Inherited from DataGridViewBand.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the DataGridViewBand and optionally releases the managed resources. (Overrides DataGridViewBand.Dispose(Boolean).)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeReleases the resources associated with the band. (Inherited from DataGridViewBand.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetPreferredWidthCalculates the ideal width of the column based on the specified criteria.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnDataGridViewChangedCalled when the band is associated with a different DataGridView. (Inherited from DataGridViewBand.)
Protected methodRaiseCellClickRaises the DataGridView.CellClick event. (Inherited from DataGridViewElement.)
Protected methodRaiseCellContentClickRaises the DataGridView.CellContentClick event. (Inherited from DataGridViewElement.)
Protected methodRaiseCellContentDoubleClickRaises the DataGridView.CellContentDoubleClick event. (Inherited from DataGridViewElement.)
Protected methodRaiseCellValueChangedRaises the DataGridView.CellValueChanged event. (Inherited from DataGridViewElement.)
Protected methodRaiseDataErrorRaises the DataGridView.DataError event. (Inherited from DataGridViewElement.)
Protected methodRaiseMouseWheelRaises the Control.MouseWheel event. (Inherited from DataGridViewElement.)
Public methodToStringGets a string that describes the column. (Overrides DataGridViewBand.ToString().)
Top

  NameDescription
Public eventDisposedOccurs when the DataGridViewColumn is disposed.
Top

The DataGridViewColumn class represents a logical column in a DataGridView control. You can retrieve columns through the Columns collection of the control.

Unlike a DataGridViewRow, which contains the actual collection of cells in a DataGridView, DataGridViewColumn is used mainly to adjust the appearance and behavior of the column user interface (UI), such as column width and cell style. For more information about cell styles, see Cell Styles in the Windows Forms DataGridView Control.

Types that derive from DataGridViewColumn typically initialize the CellTemplate property to a new instance of a related type derived from the DataGridViewCell class. Any column properties that relate to the appearance or behavior of individual cells are wrappers for the corresponding properties of the template cell. Changing one of these properties on the column automatically changes the value on the cell template and on all cells in the column. To override the specified value for individual cells, set the cell values after you set the column value.

Notes to Inheritors

When you derive from DataGridViewColumn 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 creates a Windows Form with a DataGridView and a set of buttons. Each button label describes an operation related to a DataGridViewColumn property, such as swapping the first and last column (using the DisplayIndex property) or changing the text of a column header (using the HeaderText property). Clicking a button changes the associated property of the DataGridViewColumn.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft