DataGridViewButtonColumn.FlatStyle 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 flat-style appearance of the button cells in the column.

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

public FlatStyle FlatStyle { get; set; }

Property Value

Type: System.Windows.Forms.FlatStyle

A FlatStyle value indicating the appearance of the buttons in the column. The default is Standard.

Exception Condition
InvalidOperationException

The value of the CellTemplate property is null.

The FlatStyle property specifies the appearance of the cells in the column. For more information, see the FlatStyle enumeration.

Getting or setting this property gets or sets the FlatStyle property of the object returned by the CellTemplate property. Setting this property also sets the FlatStyle property of every cell in the column and refreshes the column display. To override the specified value for individual cells, set the cell values after you set the column value.

The following code example demonstrates how to use a DataGridViewButtonColumn to view the sales an employee has made. 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: