6 out of 9 rated this helpful - Rate this topic

IEquatable<T>::Equals Method

Updated: July 2008

Indicates whether the current object is equal to another object of the same type.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
bool Equals(
	T other
)

Parameters

other
Type: T

An object to compare with this object.

Return Value

Type: System::Boolean
true if the current object is equal to the other parameter; otherwise, false.

The implementation of the Equals method is intended to perform a test for equality with another object of type T, the same type as the current object. The Equals method is called in the following circumstances:

In other words, to handle the possibility that objects of a class will be stored in an array or a generic collection object, it is a good idea to implement IEquatable<T> so that the object can be easily identified and manipulated.

When implementing the Equals method, define equality appropriately for the type specified by the generic type argument. For example, if the type argument is Int32, define equality appropriately for the comparison of two 32-bit signed integers.

Notes to Implementers:

If you implement Equals, you should also override the base class implementations of Object::Equals(Object) and GetHashCode so that their behavior is consistent with that of the IEquatable<T>::Equals method. If you do override Object::Equals(Object), your overridden implementation is also called in calls to the static Equals(System.Object, System.Object) method on your class. This ensures that all invocations of the Equals method return consistent results, which the example illustrates.

The following example shows the partial implementation of a Person class that implements IEquatable<T> and has two properties, LastName and SSN. The Equals method returns True if the SSN property of two Person objects is identical; otherwise, it returns False.

No code example is currently available or this language may not be supported.

Person objects can then be stored in a List<T> object and can be identified by the Contains method, as the following example shows.

No code example is currently available or this language may not be supported.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Date

History

Reason

July 2008

Added detail on usage and callbacks.

Information enhancement.

July 2008

Added an example.

Information enhancement.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.