DataGridViewButtonColumn.Text Property

Definition

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

public:
 property System::String ^ Text { System::String ^ get(); void set(System::String ^ value); };
public string Text { get; set; }
public string? Text { get; set; }
member this.Text : string with get, set
Public Property Text As String

Property Value

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

Exceptions

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

Examples

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 = gcnew 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);

    }
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);
}
Private Sub AddButtonColumn()
    Dim buttons As New DataGridViewButtonColumn()
    With buttons
        .HeaderText = "Sales"
        .Text = "Sales"
        .UseColumnTextForButtonValue = True
        .AutoSizeMode = DataGridViewAutoSizeColumnMode.DisplayedCells
        .FlatStyle = FlatStyle.Standard
        .CellTemplate.Style.BackColor = Color.Honeydew
        .DisplayIndex = 0
    End With

    DataGridView1.Columns.Add(buttons)

End Sub

Remarks

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.

Applies to

See also