This documentation is archived and is not being maintained.

Color.Equality Operator

Tests whether two specified Color structures are equivalent.

Namespace:  System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)

public static bool operator ==(
	Color left,
	Color right
)

Parameters

left
Type: System.Drawing.Color
The Color that is to the left of the equality operator.
right
Type: System.Drawing.Color
The Color that is to the right of the equality operator.

Return Value

Type: System.Boolean
true if the two Color structures are equal; otherwise, false.

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.

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.


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

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


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: