DataGridViewButtonColumn.Text Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the default text displayed on the button cell.

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

public string Text { get; set; }

Property Value

Type: System.String

A String that contains the text. The default is Empty.

Exception Condition
InvalidOperationException

When setting this property, the value of the CellTemplate property is null.

Each DataGridViewButtonCell contained in the column that has as a UseColumnTextForButtonValue property value of true displays the Text property value on the cell's button.

If there is an associated DataGridView control, changing this property refreshes the column display.

The following code example demonstrates how to use a DataGridViewButtonColumn to view the sales an employee has made. The Text property is used to set the column header. This example is part of a larger example available in the DataGridViewComboBoxColumn class overview topic.

private void AddButtonColumn()
{
    DataGridViewButtonColumn buttons = new DataGridViewButtonColumn();
    {
        buttons.HeaderText = "Sales";
        buttons.Text = "Sales";
        buttons.UseColumnTextForButtonValue = true;
        buttons.AutoSizeMode =
            DataGridViewAutoSizeColumnMode.AllCells;
        buttons.FlatStyle = FlatStyle.Standard;
        buttons.CellTemplate.Style.BackColor = Color.Honeydew;
        buttons.DisplayIndex = 0;
    }

    DataGridView1.Columns.Add(buttons);

}

.NET Framework
Available since 2.0
Return to top
Show: