DataGridViewCheckBoxColumn.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 check box cells.

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 cells in the column. The default is Standard.

Exception Condition
InvalidOperationException

The value of the CellTemplate property is null.

To display the check box cells using visual styles, set this property to System and call the Application.EnableVisualStyles method before Application.Run.

Getting or setting this property gets or sets the FlatStyle property of the cell 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.

WinXpFamily

Visual styles are only supported on Windows XP Home Edition, Windows XP Professional, and Windows Server 2003.

The following code example demonstrates how to use a DataGridViewCheckBoxColumn to mark which employees are out of the office. This example is part of a larger example available in the DataGridViewComboBoxColumn class overview topic.

private void AddOutOfOfficeColumn()
{
    DataGridViewCheckBoxColumn column = new DataGridViewCheckBoxColumn();
    {
        column.HeaderText = ColumnName.OutOfOffice.ToString();
        column.Name = ColumnName.OutOfOffice.ToString();
        column.AutoSizeMode = 
            DataGridViewAutoSizeColumnMode.DisplayedCells;
        column.FlatStyle = FlatStyle.Standard;
        column.ThreeState = true;
        column.CellTemplate = new DataGridViewCheckBoxCell();
        column.CellTemplate.Style.BackColor = Color.Beige;
    }

    DataGridView1.Columns.Insert(0, column);
}

.NET Framework
Available since 2.0
Return to top
Show: