DataGrid.ResetHeaderBackColor Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Resets the HeaderBackColor property to its default value.

public:
 void ResetHeaderBackColor();

public void ResetHeaderBackColor ();

member this.ResetHeaderBackColor : unit -> unit

Public Sub ResetHeaderBackColor ()

Examples

The following code example demonstrates the use of this member.

private:
   void button1_Click( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      ColorDialog^ myColorDialog = gcnew ColorDialog;

      // Disable selecting a custom color.
      myColorDialog->AllowFullOpen = false;

      // Enable the help button.
      myColorDialog->ShowHelp = true;

      // Set the initial color to the current color.
      myColorDialog->Color = myDataGrid->HeaderBackColor;

      // Show color dialog box.
      myColorDialog->ShowDialog();

      // Set the header background color.
      myDataGrid->HeaderBackColor = myColorDialog->Color;
   }

   // Reset the header background color.
   void button2_Click( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      myDataGrid->ResetHeaderBackColor();
   }

private void button1_Click(object sender, EventArgs e)
{
   ColorDialog myColorDialog = new ColorDialog();
   // Disable selecting a custom color.
   myColorDialog.AllowFullOpen = false ;
   // Enable the help button.
   myColorDialog.ShowHelp = true ;
   // Set the initial color to the current color.
   myColorDialog.Color = myDataGrid.HeaderBackColor;
   // Show color dialog box.
   myColorDialog.ShowDialog();
   // Set the header background color.   
   myDataGrid.HeaderBackColor  = myColorDialog.Color;
}
// Reset the header background color.
private void button2_Click(object sender, EventArgs e)
{           
   myDataGrid.ResetHeaderBackColor();
}

Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles button1.Click
    Dim myColorDialog As New ColorDialog()
    ' Disable selecting a custom color.
    myColorDialog.AllowFullOpen = False
    ' Enable the help button.
    myColorDialog.ShowHelp = True
    ' Set the initial color to the current color.
    myColorDialog.Color = myDataGrid.HeaderBackColor
    ' Show color dialog box.
    myColorDialog.ShowDialog()
    ' Set the header background color.   
    myDataGrid.HeaderBackColor = myColorDialog.Color
End Sub

' Reset the header background color.
Private Sub button2_Click(ByVal sender As Object, ByVal e As EventArgs) Handles button2.Click
    myDataGrid.ResetHeaderBackColor()
End Sub

Remarks

You typically use this method if you are either creating a designer for the System.Windows.Forms.DataGrid or creating your own control incorporating the System.Windows.Forms.DataGrid. You can use the ShouldSerializeHeaderBackColor method to determine whether the property value has changed from its default.