2 out of 7 rated this helpful - Rate this topic

KeyValuePair<TKey, TValue> Structure

Defines a key/value pair that can be set or retrieved.

Namespace:  System.Collections.Generic
Assembly:  mscorlib (in mscorlib.dll)
[SerializableAttribute]
public struct KeyValuePair<TKey, TValue>

Type Parameters

TKey

The type of the key.

TValue

The type of the value.

The KeyValuePair<TKey, TValue> type exposes the following members.

  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library KeyValuePair<TKey, TValue> Initializes a new instance of the KeyValuePair<TKey, TValue> structure with the specified key and value.
Top
  Name Description
Public property Supported by the XNA Framework Supported by Portable Class Library Key Gets the key in the key/value pair.
Public property Supported by the XNA Framework Supported by Portable Class Library Value Gets the value in the key/value pair.
Top
  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library Equals Indicates whether this instance and a specified object are equal. (Inherited from ValueType.)
Protected method Supported by the XNA Framework Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetHashCode Returns the hash code for this instance. (Inherited from ValueType.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library ToString Returns a string representation of the KeyValuePair<TKey, TValue>, using the string representations of the key and value. (Overrides ValueType.ToString().)
Top

The Dictionary<TKey, TValue>.Enumerator.Current property returns an instance of this type.

The foreach statement of the C# language (for each in C++, For Each in Visual Basic) requires the type of the elements in the collection. Since each element of a collection based on IDictionary<TKey, TValue> is a key/value pair, the element type is not the type of the key or the type of the value. Instead, the element type is KeyValuePair<TKey, TValue>. For example:


foreach( KeyValuePair<string, string> kvp in myDictionary )
{
    Console.WriteLine("Key = {0}, Value = {1}", kvp.Key, kvp.Value);
}


The foreach statement is a wrapper around the enumerator, which allows only reading from, not writing to, the collection.

The following code example shows how to enumerate the keys and values in a dictionary, using the KeyValuePair<TKey, TValue> structure.

This code is part of a larger example provided for the Dictionary<TKey, TValue> class.


// When you use foreach to enumerate dictionary elements,
// the elements are retrieved as KeyValuePair objects.
Console.WriteLine();
foreach( KeyValuePair<string, string> kvp in openWith )
{
    Console.WriteLine("Key = {0}, Value = {1}", 
        kvp.Key, kvp.Value);
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ