Dictionary(TKey, TValue).Comparer Property (System.Collections.Generic)

Comparer Property

.NET Framework Class Library

Dictionary<(Of <(TKey, TValue>)>)..::.Comparer Property

Gets the IEqualityComparer<(Of <(T>)>) that is used to determine equality of keys for the dictionary.

Namespace: System.Collections.Generic
Assembly: mscorlib (in mscorlib.dll)

Syntax

Visual Basic (Declaration)

Public ReadOnly Property Comparer As IEqualityComparer(Of TKey)

Visual Basic (Usage)

Dim instance As Dictionary
Dim value As IEqualityComparer(Of TKey)

value = instance.Comparer

public IEqualityComparer<TKey> Comparer { get; }

Visual C++

public:
property IEqualityComparer<TKey>^ Comparer {
    IEqualityComparer<TKey>^ get ();
}

JScript

public function get Comparer () : IEqualityComparer<TKey>

Property Value

Type: System.Collections.Generic..::.IEqualityComparer<(Of <(TKey>)>)
The IEqualityComparer<(Of <(T>)>) generic interface implementation that is used to determine equality of keys for the current Dictionary<(Of <(TKey, TValue>)>) and to provide hash values for the keys.

Remarks

Dictionary<(Of <(TKey, TValue>)>) requires an equality implementation to determine whether keys are equal. You can specify an implementation of the IEqualityComparer<(Of <(T>)>) generic interface by using a constructor that accepts a comparer parameter; if you do not specify one, the default generic equality comparer EqualityComparer<(Of <(T>)>)..::.Default is used.

Getting the value of this property is an O(1) operation.

Platforms

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.

Version Information

.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

Reference

Dictionary<(Of <(TKey, TValue>)>) Class

Dictionary<(Of <(TKey, TValue>)>) Members

System.Collections.Generic Namespace