Export (0) Print
Expand All

IDictionary Interface

Represents a nongeneric collection of key/value pairs.

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

'Declaration
<ComVisibleAttribute(True)> _
Public Interface IDictionary _
	Inherits ICollection, IEnumerable

The IDictionary type exposes the following members.

  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsCountGets the number of elements contained in the ICollection. (Inherited from ICollection.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsIsFixedSizeGets a value indicating whether the IDictionary object has a fixed size.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsIsReadOnlyGets a value indicating whether the IDictionary object is read-only.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsIsSynchronizedGets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from ICollection.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsItemGets or sets the element with the specified key.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsKeysGets an ICollection object containing the keys of the IDictionary object.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsSyncRootGets an object that can be used to synchronize access to the ICollection. (Inherited from ICollection.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsValuesGets an ICollection object containing the values in the IDictionary object.
Top

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsAddAdds an element with the provided key and value to the IDictionary object.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsClearRemoves all elements from the IDictionary object.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsContainsDetermines whether the IDictionary object contains an element with the specified key.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsCopyToCopies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from ICollection.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetEnumeratorReturns an IDictionaryEnumerator object for the IDictionary object.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsRemoveRemoves the element with the specified key from the IDictionary object.
Top

  NameDescription
Public Extension MethodSupported by Portable Class LibrarySupported in .NET for Windows Store appsAsParallelEnables parallelization of a query. (Defined by ParallelEnumerable.)
Public Extension MethodSupported by Portable Class LibrarySupported in .NET for Windows Store appsAsQueryableConverts an IEnumerable to an IQueryable. (Defined by Queryable.)
Public Extension MethodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsCast(Of TResult)Casts the elements of an IEnumerable to the specified type. (Defined by Enumerable.)
Public Extension MethodSupported by the XNA FrameworkSupported by Portable Class LibrarySupported in .NET for Windows Store appsOfType(Of TResult)Filters the elements of an IEnumerable based on a specified type. (Defined by Enumerable.)
Top

The IDictionary interface is the base interface for nongeneric collections of key/value pairs. For the generic version of this interface, see System.Collections.Generic.IDictionary(Of TKey, TValue).

Each element is a key/value pair stored in a DictionaryEntry object.

Each pair must have a unique key. Implementations can vary in whether they allow the key to be null. The value can be null and does not have to be unique. The IDictionary interface allows the contained keys and values to be enumerated, but it does not imply any particular sort order.

IDictionary implementations fall into three categories: read-only, fixed-size, variable-size. A read-only IDictionary object cannot be modified. A fixed-size IDictionary object does not allow the addition or removal of elements, but does allow the modification of existing elements. A variable-size IDictionary object allows the addition, removal, and modification of elements.

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

For Each de As DictionaryEntry In myDictionary
    '... 
Next de

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

Notes to Implementers

The implementing class must have a means to compare keys.

The following code example demonstrates how to define a simple dictionary class that implements the IDictionary interface.

Imports System
Imports System.Collections

' This class implements a simple dictionary using an array of DictionaryEntry objects (key/value pairs). 
Public Class SimpleDictionary
    Implements IDictionary

    ' The array of items 
    Dim items() As DictionaryEntry
    Dim ItemsInUse As Integer = 0

    ' Construct the SimpleDictionary with the desired number of items. 
    ' The number of items cannot change for the life time of this SimpleDictionary. 
    Public Sub New(ByVal numItems As Integer)
        items = New DictionaryEntry(numItems - 1) {}
    End Sub 

    ' IDictionary Members 
    Public ReadOnly Property IsReadOnly() As Boolean Implements IDictionary.IsReadOnly
        Get 
            Return False 
        End Get 
    End Property 

    Public Function Contains(ByVal key As Object) As Boolean Implements IDictionary.Contains
        Dim index As Integer 
        Return TryGetIndexOfKey(key, index)
    End Function 

    Public ReadOnly Property IsFixedSize() As Boolean Implements IDictionary.IsFixedSize
        Get 
            Return False 
        End Get 
    End Property 

    Public Sub Remove(ByVal key As Object) Implements IDictionary.Remove
        If key = Nothing Then 
            Throw New ArgumentNullException("key")
        End If 
        ' Try to find the key in the DictionaryEntry array 
        Dim index As Integer 
        If TryGetIndexOfKey(key, index) Then 

            ' If the key is found, slide all the items up.
            Array.Copy(items, index + 1, items, index, (ItemsInUse - index) - 1)
            ItemsInUse = ItemsInUse - 1
        Else 

            ' If the key is not in the dictionary, just return.  
        End If 
    End Sub 

    Public Sub Clear() Implements IDictionary.Clear
        ItemsInUse = 0
    End Sub 

    Public Sub Add(ByVal key As Object, ByVal value As Object) Implements IDictionary.Add

        ' Add the new key/value pair even if this key already exists in the dictionary. 
        If ItemsInUse = items.Length Then 
            Throw New InvalidOperationException("The dictionary cannot hold any more items.")
        End If
        items(ItemsInUse) = New DictionaryEntry(key, value)
        ItemsInUse = ItemsInUse + 1
    End Sub 

    Public ReadOnly Property Keys() As ICollection Implements IDictionary.Keys
        Get 

            ' Return an array where each item is a key. 
            ' Note: Declaring keyArray() to have a size of ItemsInUse - 1 
            '       ensures that the array is properly sized, in VB.NET 
            '       declaring an array of size N creates an array with 
            '       0 through N elements, including N, as opposed to N - 1 
            '       which is the default behavior in C# and C++. 
            Dim keyArray() As Object = New Object(ItemsInUse - 1) {}
            Dim n As Integer 
            For n = 0 To ItemsInUse - 1
                keyArray(n) = items(n).Key
            Next n

            Return keyArray
        End Get 
    End Property 

    Public ReadOnly Property Values() As ICollection Implements IDictionary.Values
        Get 
            ' Return an array where each item is a value. 
            Dim valueArray() As Object = New Object(ItemsInUse - 1) {}
            Dim n As Integer 
            For n = 0 To ItemsInUse - 1
                valueArray(n) = items(n).Value
            Next n

            Return valueArray
        End Get 
    End Property 

    Public Property Item(ByVal key As Object) As Object Implements IDictionary.Item
        Get 

            ' If this key is in the dictionary, return its value. 
            Dim index As Integer 
            If TryGetIndexOfKey(key, index) Then 

                ' The key was found return its value. 
                Return items(index).Value
            Else 

                ' The key was not found return null. 
                Return Nothing 
            End If 
        End Get 

        Set(ByVal value As Object)
            ' If this key is in the dictionary, change its value.  
            Dim index As Integer 
            If TryGetIndexOfKey(key, index) Then 

                ' The key was found change its value.
                items(index).Value = value
            Else 

                ' This key is not in the dictionary add this key/value pair.
                Add(key, value)
            End If 
        End Set 
    End Property 

    Private Function TryGetIndexOfKey(ByVal key As Object, ByRef index As Integer) As Boolean 
        For index = 0 To ItemsInUse - 1
            ' If the key is found, return true (the index is also returned). 
            If items(index).Key.Equals(key) Then 
                Return True 
            End If 
        Next index

        ' Key not found, return false (index should be ignored by the caller). 
        Return False 
    End Function 

    Private Class SimpleDictionaryEnumerator
        Implements IDictionaryEnumerator

        ' A copy of the SimpleDictionary object's key/value pairs. 
        Dim items() As DictionaryEntry
        Dim index As Integer = -1

        Public Sub New(ByVal sd As SimpleDictionary)
            ' Make a copy of the dictionary entries currently in the SimpleDictionary object.
            items = New DictionaryEntry(sd.Count - 1) {}
            Array.Copy(sd.items, 0, items, 0, sd.Count)
        End Sub 

        ' Return the current item. 
        Public ReadOnly Property Current() As Object Implements IDictionaryEnumerator.Current
            Get
                ValidateIndex()
                Return items(index)
            End Get 
        End Property 

        ' Return the current dictionary entry. 
        Public ReadOnly Property Entry() As DictionaryEntry Implements IDictionaryEnumerator.Entry
            Get 
                Return Current
            End Get 
        End Property 

        ' Return the key of the current item. 
        Public ReadOnly Property Key() As Object Implements IDictionaryEnumerator.Key
            Get
                ValidateIndex()
                Return items(index).Key
            End Get 
        End Property 

        ' Return the value of the current item. 
        Public ReadOnly Property Value() As Object Implements IDictionaryEnumerator.Value
            Get
                ValidateIndex()
                Return items(index).Value
            End Get 
        End Property 

        ' Advance to the next item. 
        Public Function MoveNext() As Boolean Implements IDictionaryEnumerator.MoveNext
            If index < items.Length - 1 Then
                index = index + 1
                Return True 
            End If 

            Return False 
        End Function 

        ' Validate the enumeration index and throw an exception if the index is out of range. 
        Private Sub ValidateIndex()
            If index < 0 Or index >= items.Length Then 
                Throw New InvalidOperationException("Enumerator is before or after the collection.")
            End If 
        End Sub 

        ' Reset the index to restart the enumeration. 
        Public Sub Reset() Implements IDictionaryEnumerator.Reset
            index = -1
        End Sub 

    End Class 

    Public Function GetEnumerator() As IDictionaryEnumerator Implements IDictionary.GetEnumerator

        'Construct and return an enumerator. 
        Return New SimpleDictionaryEnumerator(Me)
    End Function 


    ' ICollection Members 
    Public ReadOnly Property IsSynchronized() As Boolean Implements IDictionary.IsSynchronized
        Get 
            Return False 
        End Get 
    End Property 

    Public ReadOnly Property SyncRoot() As Object Implements IDictionary.SyncRoot
        Get 
            Throw New NotImplementedException()
        End Get 
    End Property 

    Public ReadOnly Property Count() As Integer Implements IDictionary.Count
        Get 
            Return ItemsInUse
        End Get 
    End Property 

    Public Sub CopyTo(ByVal array As Array, ByVal index As Integer) Implements IDictionary.CopyTo
        Throw New NotImplementedException()
    End Sub 

    ' IEnumerable Members 
    Public Function GetEnumerator1() As IEnumerator Implements IEnumerable.GetEnumerator

        ' Construct and return an enumerator. 
        Return Me.GetEnumerator()
    End Function 
End Class 

Public NotInheritable Class App
    Public Shared Sub Main()
        ' Create a dictionary that contains no more than three entries. 
        Dim d As IDictionary = New SimpleDictionary(3)

        ' Add three people and their ages to the dictionary.
        d.Add("Jeff", 40)
        d.Add("Kristin", 34)
        d.Add("Aidan", 1)

        Console.WriteLine("Number of elements in dictionary = {0}", d.Count)

        Console.WriteLine("Does dictionary contain 'Jeff'? {0}", d.Contains("Jeff"))
        Console.WriteLine("Jeff's age is {0}", d("Jeff"))

        ' Display every entry's key and value. 
        Dim de As DictionaryEntry
        For Each de In d
            Console.WriteLine("{0} is {1} years old.", de.Key, de.Value)
        Next 

        ' Remove an entry that exists.
        d.Remove("Jeff")

        ' Remove an entry that does not exist, but do not throw an exception.
        d.Remove("Max")

        ' Show the names (keys) of the people in the dictionary. 
        Dim s As String 

        For Each s In d.Keys
            Console.WriteLine(s)
        Next 

        ' Show the ages (values) of the people in the dictionary. 
        Dim age As Integer 
        For Each age In d.Values
            Console.WriteLine(age)
        Next 

    End Sub 
End Class 

' This code produces the following output. 

' Number of elements in dictionary = 3 
' Does dictionary contain 'Jeff'? True 
' Jeff's age is 40 
' Jeff is 40 years old. 
' Kristin is 34 years old. 
' Aidan is 1 years old. 
' Kristin 
' Aidan 
' 34 
' 1

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft