DataGridViewButtonCell Class
Displays a button-like user interface (UI) for use in a DataGridView control.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
The DataGridViewButtonCell class is a specialized type of DataGridViewCell used to display a button-like UI.
DataGridViewButtonColumn is the column type specialized to hold cells of this type. To pattern the cells within a column after an existing DataGridViewButtonCell, set the column's CellTemplate property to the cell to use as a pattern. By default, the CellTemplate is initialized to a new DataGridViewButtonCell.
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 a the button column. You can use the DataGridViewCellEventArgs.RowIndex property to determine whether the click occurred in a particular button cell.
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.
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 DataGridViewButtonCell 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. You can use similar code when working with individual DataGridViewButtonCell objects. 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.
Public Class Form1 Inherits Form Private employees As New List(Of Employee) Private tasks As New List(Of Task) Private WithEvents reportButton As New Button Private WithEvents dataGridView1 As New DataGridView <STAThread()> _ Public Sub Main() Application.Run(New Form1) End Sub Sub New() dataGridView1.Dock = DockStyle.Fill dataGridView1.AutoSizeColumnsMode = _ DataGridViewAutoSizeColumnsMode.AllCells reportButton.Text = "Generate Report" reportButton.Dock = DockStyle.Top Controls.Add(dataGridView1) Controls.Add(reportButton) Text = "DataGridViewComboBoxColumn Demo" End Sub ' Initializes the data source and populates the DataGridView control. Private Sub Form1_Load(ByVal sender As Object, _ ByVal e As EventArgs) Handles Me.Load PopulateLists() dataGridView1.AutoGenerateColumns = False dataGridView1.DataSource = tasks AddColumns() End Sub ' Populates the employees and tasks lists. Private Sub PopulateLists() employees.Add(New Employee("Harry")) employees.Add(New Employee("Sally")) employees.Add(New Employee("Roy")) employees.Add(New Employee("Pris")) tasks.Add(New Task(1, employees(1))) tasks.Add(New Task(2)) tasks.Add(New Task(3, employees(2))) tasks.Add(New Task(4)) End Sub ' Configures columns for the DataGridView control. Private Sub AddColumns() Dim idColumn As New DataGridViewTextBoxColumn() idColumn.Name = "Task" idColumn.DataPropertyName = "Id" idColumn.ReadOnly = True Dim assignedToColumn As New DataGridViewComboBoxColumn() ' Populate the combo box drop-down list with Employee objects. For Each e As Employee In employees assignedToColumn.Items.Add(e) Next ' Add "unassigned" to the drop-down list and display it for ' empty AssignedTo values or when the user presses CTRL+0. assignedToColumn.Items.Add("unassigned") assignedToColumn.DefaultCellStyle.NullValue = "unassigned" assignedToColumn.Name = "Assigned To" assignedToColumn.DataPropertyName = "AssignedTo" assignedToColumn.AutoComplete = True assignedToColumn.DisplayMember = "Name" assignedToColumn.ValueMember = "Self" ' Add a button column. Dim buttonColumn As New DataGridViewButtonColumn() buttonColumn.HeaderText = "" buttonColumn.Name = "Status Request" buttonColumn.Text = "Request Status" buttonColumn.UseColumnTextForButtonValue = True dataGridView1.Columns.Add(idColumn) dataGridView1.Columns.Add(assignedToColumn) dataGridView1.Columns.Add(buttonColumn) End Sub ' Reports on task assignments. Private Sub reportButton_Click(ByVal sender As Object, _ ByVal e As EventArgs) Handles reportButton.Click Dim report As New StringBuilder() For Each t As Task In tasks Dim assignment As String If t.AssignedTo Is Nothing Then assignment = "unassigned" Else assignment = "assigned to " + t.AssignedTo.Name End If report.AppendFormat("Task {0} is {1}.", t.Id, assignment) report.Append(Environment.NewLine) Next MessageBox.Show(report.ToString(), "Task Assignments") End Sub ' Calls the Employee.RequestStatus method. Private Sub dataGridView1_CellClick(ByVal sender As Object, _ ByVal e As DataGridViewCellEventArgs) _ Handles dataGridView1.CellClick ' Ignore clicks that are not on button cells. If e.RowIndex < 0 OrElse Not e.ColumnIndex = _ dataGridView1.Columns("Status Request").Index Then Return ' Retrieve the task ID. Dim taskID As Int32 = CInt(dataGridView1(0, e.RowIndex).Value) ' Retrieve the Employee object from the "Assigned To" cell. Dim assignedTo As Employee = TryCast(dataGridView1.Rows(e.RowIndex) _ .Cells("Assigned To").Value, Employee) ' Request status through the Employee object if present. If assignedTo IsNot Nothing Then assignedTo.RequestStatus(taskID) Else MessageBox.Show(String.Format( _ "Task {0} is unassigned.", taskID), "Status Request") End If End Sub End Class
System.Windows.Forms.DataGridViewElement
System.Windows.Forms.DataGridViewCell
System.Windows.Forms.DataGridViewButtonCell
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note: