DataGridViewButtonColumn Class
Hosts a collection of DataGridViewButtonCell objects.
System.Windows.Forms::DataGridViewElement
System.Windows.Forms::DataGridViewBand
System.Windows.Forms::DataGridViewColumn
System.Windows.Forms::DataGridViewButtonColumn
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
The DataGridViewButtonColumn type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | DataGridViewButtonColumn | Initializes a new instance of the DataGridViewButtonColumn class to the default state. |
| Name | Description | |
|---|---|---|
![]() | 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 create new cells. (Overrides DataGridViewColumn::CellTemplate.) |
![]() | 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. (Overrides DataGridViewColumn::DefaultCellStyle.) |
![]() | 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.) |
![]() | FlatStyle | Gets or sets the flat-style appearance of the button cells in the column. |
![]() | 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.) |
![]() | 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 | Infrastructure. Gets or sets the site of the column. (Inherited from DataGridViewColumn.) |
![]() | SortMode | Gets or sets the sort mode for the column. (Inherited from DataGridViewColumn.) |
![]() | 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.) |
![]() | Text | Gets or sets the default text displayed on the button cell. |
![]() | ToolTipText | Gets or sets the text used for ToolTips. (Inherited from DataGridViewColumn.) |
![]() | UseColumnTextForButtonValue | Gets or sets a value indicating whether the Text property value is displayed as the button text for cells in this column. |
![]() | 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.) |
| Name | Description | |
|---|---|---|
![]() | Clone | Creates an exact copy of this column. (Overrides DataGridViewColumn::Clone().) |
![]() | 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.) |
![]() | Finalize | Releases the resources associated with the band. (Inherited from DataGridViewBand.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetPreferredWidth | 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 | Raises the DataGridView::CellClick event. (Inherited from DataGridViewElement.) |
![]() | RaiseCellContentClick | Raises the DataGridView::CellContentClick event. (Inherited from DataGridViewElement.) |
![]() | RaiseCellContentDoubleClick | Raises the DataGridView::CellContentDoubleClick event. (Inherited from DataGridViewElement.) |
![]() | RaiseCellValueChanged | Raises the DataGridView::CellValueChanged event. (Inherited from DataGridViewElement.) |
![]() | RaiseDataError | Raises the DataGridView::DataError event. (Inherited from DataGridViewElement.) |
![]() | RaiseMouseWheel | Raises the Control::MouseWheel event. (Inherited from DataGridViewElement.) |
![]() | ToString | Gets a string that describes the column. (Overrides DataGridViewColumn::ToString().) |
| Name | Description | |
|---|---|---|
![]() | Disposed | Occurs when the DataGridViewColumn is disposed. (Inherited from DataGridViewColumn.) |
The DataGridViewButtonColumn class is a specialized type of the DataGridViewColumn class used to logically host cells that respond to simple user input. A DataGridViewButtonColumn has an associated DataGridViewButtonCell in every DataGridViewRow that intersects it. Each cell supplies a user interface (UI) that is similar to a Button control.
To display the same button text for every cell, set the UseColumnTextForButtonValue property to true and set the Text property to the desired button text.
The default sort mode for this column type is NotSortable.
To respond to user button clicks, handle the DataGridView::CellClick or DataGridView::CellContentClick event. In the event handler, you can use the DataGridViewCellEventArgs::ColumnIndex property to determine whether the click occurred in the button column. You can use the DataGridViewCellEventArgs::RowIndex property to determine whether the click occurred in a button cell and not on the column header.
Note |
|---|
When visual styles are enabled, the buttons in a button column are painted using a ButtonRenderer, and cell styles specified through properties such as DefaultCellStyle have no effect. |
When you derive from DataGridViewButtonColumn 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 DataGridViewButtonColumn to perform actions on particular rows. In this example, a DataGridView::CellClick event handler first determines whether a click is on a button cell, then retrieves a business object associated with the row. This example is part of a larger example available in How to: Access Objects in a Windows Forms DataGridViewComboBoxCell Drop-Down List.
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.
