Color.Equality(Color, Color) Operator

Definition

Namespace:: System.Drawing

Assembly:: System.Drawing.Primitives.dll

Assembly:: System.Drawing.dll

Assembly:: netstandard.dll

Tests whether two specified Color structures are equivalent.

public:
 static bool operator ==(System::Drawing::Color left, System::Drawing::Color right);

public static bool operator == (System.Drawing.Color left, System.Drawing.Color right);

static member ( = ) : System.Drawing.Color * System.Drawing.Color -> bool

Public Shared Operator == (left As Color, right As Color) As Boolean

Parameters

left: Color

The Color that is to the left of the equality operator.

right: Color

The Color that is to the right of the equality operator.

Returns

Boolean

true if the two Color structures are equal; otherwise, false.

Examples

The following code example demonstrates the Equality operator and the SystemColors class. This example is designed to be used with a Windows Form that contains a button named Button1. Paste the following code into your form and associate the Button1_Click method with the button's Click event.

void Button1_Click( System::Object^ /*sender*/, System::EventArgs^ /*e*/ )
{
   if ( this->BackColor == SystemColors::ControlDark )
   {
      this->BackColor = SystemColors::Control;
   }
}

private void Button1_Click(System.Object sender, System.EventArgs e)
{

    if (this.BackColor == SystemColors.ControlDark)
    {
        this.BackColor = SystemColors.Control;
    }
}

Private Sub Button1_Click(ByVal sender As System.Object, _
    ByVal e As System.EventArgs) Handles Button1.Click

    If (Color.op_Equality(Me.BackColor, SystemColors.ControlDark)) Then
        Me.BackColor = SystemColors.Control
    End If
End Sub

Remarks

This method compares more than the ARGB values of the Color structures. It also does a comparison of some state flags. If you want to compare just the ARGB values of two Color structures, compare them using the ToArgb method.

Applies to