IEquatable<(Of <(T>)>) Interface
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
Defines a generalized method that a value type or class implements to create a type-specific method for determining equality of instances.
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Syntax
Public Interface IEquatable(Of T)
public interface IEquatable<T>
Type Parameters
- T
The type of objects to compare.
The IEquatable<(Of <(T>)>) type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Equals | Indicates whether the current object is equal to another object of the same type. |
Top
Remarks
This interface is implemented by types whose values can be equated (for example, the numeric and string classes). A value type or class implements the Equals method to create a type-specific method suitable for determining equality of instances.
Note
The IComparable<(Of <(T>)>) interface defines the CompareTo method, which determines the sort order of instances of the implementing type. The IEquatable<(Of <(T>)>) interface defines the Equals method, which determines the equality of instances of the implementing type.
The IEquatable<(Of <(T>)>) interface is used by generic collection objects such as Dictionary<(Of <(TKey, TValue>)>), List<(Of <(T>)>), and LinkedList<(Of <(T>)>) when testing for equality in such methods as Contains, IndexOf, LastIndexOf, and Remove. It should be implemented for any object that might be stored in a generic collection.
Notes to Implementers
Replace the type parameter of the IEquatable<(Of <(T>)>) interface with the type that is implementing this interface.
If you implement IEquatable<(Of <(T>)>), 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<(Of <(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.
Examples
See the example for the IEquatable<(Of <(T>)>)..::.Equals method.
Version Information
Windows Phone OS
Supported in: 8.1, 8.0, 7.1, 7.0
Platforms
Windows Phone