This documentation is archived and is not being maintained.

DictionaryEntry Structure

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

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

public struct DictionaryEntry

The DictionaryEntry type exposes the following members.

Public methodSupported by the XNA FrameworkDictionaryEntryInitializes an instance of the DictionaryEntry type with the specified key and value.

Public propertySupported by the XNA FrameworkKeyGets or sets the key in the key/value pair.
Public propertySupported by the XNA FrameworkValueGets or sets the value in the key/value pair.

Public methodSupported by the XNA FrameworkEqualsIndicates whether this instance and a specified object are equal. (Inherited from ValueType.)
Protected methodSupported by the XNA FrameworkFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkGetHashCodeReturns the hash code for this instance. (Inherited from ValueType.)
Public methodSupported by the XNA FrameworkGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)

In XNA Framework 3.0, this member is inherited from Object.ToString().

The IDictionaryEnumerator.Entry method returns an instance of this type.

The foreach statement of the C# language (for each in Visual C++, For Each in Visual Basic) requires the type of each element in the collection. Since each element of the IDictionary 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 DictionaryEntry. For example:

foreach (DictionaryEntry de in openWith)
    Console.WriteLine("Key = {0}, Value = {1}", de.Key, de.Value);

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

The following example demonstrates the use of DictionaryEntry to iterate through a Hashtable object.

// A simple example for the DictionaryEntry structure.
using System;
using System.Collections;

class Example
    public static void Main()
        // Create a new hash table.
        Hashtable openWith = new Hashtable();

        // Add some elements to the hash table. There are no 
        // duplicate keys, but some of the values are duplicates.
        openWith.Add("txt", "notepad.exe");
        openWith.Add("bmp", "paint.exe");
        openWith.Add("dib", "paint.exe");
        openWith.Add("rtf", "wordpad.exe");

        // When you use foreach to enumerate hash table elements,
        // the elements are retrieved as KeyValuePair objects.
        foreach (DictionaryEntry de in openWith)
            Console.WriteLine("Key = {0}, Value = {1}", de.Key, de.Value);

/* This code example produces output similar to the following:

Key = rtf, Value = wordpad.exe
Key = txt, Value = notepad.exe
Key = dib, Value = paint.exe
Key = bmp, Value = paint.exe

.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

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.