Color.Equality Operator (System.Drawing)

.NET Framework Class Library

Color..::.Equality Operator

Tests whether two specified Color structures are equivalent.

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

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

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

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

static let inline (=)
        left:Color * 
        right:Color  : bool

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.

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.

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.


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


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

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


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

Version Information

.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

Platforms

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.

Reference

Color Structure

System.Drawing Namespace

Advertise Here