Auf Englisch lesen

Freigeben über


IDictionary Schnittstelle

Definition

Stellt eine nichtgenerische Auflistung von Schlüssel-Wert-Paaren dar.

C#
public interface IDictionary : System.Collections.ICollection
C#
[System.Runtime.InteropServices.ComVisible(true)]
public interface IDictionary : System.Collections.ICollection
Abgeleitet
Attribute
Implementiert

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie eine einfache Wörterbuchklasse definiert wird, die die IDictionary Schnittstelle implementiert.

C#
using System;
using System.Collections;

// This class implements a simple dictionary using an array of DictionaryEntry objects (key/value pairs).
public class SimpleDictionary : IDictionary
{
    // The array of items
    private DictionaryEntry[] items;
    private Int32 ItemsInUse = 0;

    // Construct the SimpleDictionary with the desired number of items.
    // The number of items cannot change for the life time of this SimpleDictionary.
    public SimpleDictionary(Int32 numItems)
    {
        items = new DictionaryEntry[numItems];
    }

    #region IDictionary Members
    public bool IsReadOnly { get { return false; } }
    public bool Contains(object key)
    {
       Int32 index;
       return TryGetIndexOfKey(key, out index);
    }
    public bool IsFixedSize { get { return false; } }
    public void Remove(object key)
    {
        if (key == null) throw new ArgumentNullException("key");
        // Try to find the key in the DictionaryEntry array
        Int32 index;
        if (TryGetIndexOfKey(key, out index))
        {
            // If the key is found, slide all the items up.
            Array.Copy(items, index + 1, items, index, ItemsInUse - index - 1);
            ItemsInUse--;
        }
        else
        {
            // If the key is not in the dictionary, just return.
        }
    }
    public void Clear() { ItemsInUse = 0; }
    public void Add(object key, object value)
    {
        // Add the new key/value pair even if this key already exists in the dictionary.
        if (ItemsInUse == items.Length)
            throw new InvalidOperationException("The dictionary cannot hold any more items.");
        items[ItemsInUse++] = new DictionaryEntry(key, value);
    }
    public ICollection Keys
    {
        get
        {
            // Return an array where each item is a key.
            Object[] keys = new Object[ItemsInUse];
            for (Int32 n = 0; n < ItemsInUse; n++)
                keys[n] = items[n].Key;
            return keys;
        }
    }
    public ICollection Values
    {
        get
        {
            // Return an array where each item is a value.
            Object[] values = new Object[ItemsInUse];
            for (Int32 n = 0; n < ItemsInUse; n++)
                values[n] = items[n].Value;
            return values;
        }
    }
    public object this[object key]
    {
        get
        {
            // If this key is in the dictionary, return its value.
            Int32 index;
            if (TryGetIndexOfKey(key, out index))
            {
                // The key was found; return its value.
                return items[index].Value;
            }
            else
            {
                // The key was not found; return null.
                return null;
            }
        }

        set
        {
            // If this key is in the dictionary, change its value.
            Int32 index;
            if (TryGetIndexOfKey(key, out index))
            {
                // 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);
            }
        }
    }
    private Boolean TryGetIndexOfKey(Object key, out Int32 index)
    {
        for (index = 0; index < ItemsInUse; index++)
        {
            // If the key is found, return true (the index is also returned).
            if (items[index].Key.Equals(key)) return true;
        }

        // Key not found, return false (index should be ignored by the caller).
        return false;
    }
    private class SimpleDictionaryEnumerator : IDictionaryEnumerator
    {
        // A copy of the SimpleDictionary object's key/value pairs.
        DictionaryEntry[] items;
        Int32 index = -1;

        public SimpleDictionaryEnumerator(SimpleDictionary sd)
        {
            // Make a copy of the dictionary entries currently in the SimpleDictionary object.
            items = new DictionaryEntry[sd.Count];
            Array.Copy(sd.items, 0, items, 0, sd.Count);
        }

        // Return the current item.
        public Object Current { get { ValidateIndex(); return items[index]; } }

        // Return the current dictionary entry.
        public DictionaryEntry Entry
        {
            get { return (DictionaryEntry) Current; }
        }

        // Return the key of the current item.
        public Object Key { get { ValidateIndex();  return items[index].Key; } }

        // Return the value of the current item.
        public Object Value { get { ValidateIndex();  return items[index].Value; } }

        // Advance to the next item.
        public Boolean MoveNext()
        {
            if (index < items.Length - 1) { index++; return true; }
            return false;
        }

        // Validate the enumeration index and throw an exception if the index is out of range.
        private void ValidateIndex()
        {
            if (index < 0 || index >= items.Length)
            throw new InvalidOperationException("Enumerator is before or after the collection.");
        }

        // Reset the index to restart the enumeration.
        public void Reset()
        {
            index = -1;
        }
    }
    public IDictionaryEnumerator GetEnumerator()
    {
        // Construct and return an enumerator.
        return new SimpleDictionaryEnumerator(this);
    }
    #endregion

    #region ICollection Members
    public bool IsSynchronized { get { return false; } }
    public object SyncRoot { get { throw new NotImplementedException(); } }
    public int Count { get { return ItemsInUse; } }
    public void CopyTo(Array array, int index) { throw new NotImplementedException(); }
    #endregion

    #region IEnumerable Members
    IEnumerator IEnumerable.GetEnumerator()
    {
        // Construct and return an enumerator.
        return ((IDictionary)this).GetEnumerator();
    }
    #endregion
}

public sealed class App
{
    static void Main()
    {
        // Create a dictionary that contains no more than three entries.
        IDictionary d = 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.
        foreach (DictionaryEntry de in d)
        {
            Console.WriteLine("{0} is {1} years old.", de.Key, de.Value);
        }

        // 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.
        foreach (String s in d.Keys)
            Console.WriteLine(s);

        // Show the ages (values) of the people in the dictionary.
        foreach (Int32 age in d.Values)
            Console.WriteLine(age);
    }
}

// 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

Hinweise

Die IDictionary Schnittstelle ist die Basisschnittstelle für nichtgenerische Auflistungen von Schlüssel-Wert-Paaren. Die generische Version dieser Schnittstelle finden Sie unter System.Collections.Generic.IDictionary<TKey,TValue>.

Jedes Element ist ein Schlüssel-Wert-Paar, das in einem DictionaryEntry-Objekt gespeichert ist.

Jedes Paar muss über einen eindeutigen Schlüssel verfügen. Implementierungen können variieren, ob sie zulassen, dass der Schlüssel null ist. Der Wert kann null sein und muss nicht eindeutig sein. Die IDictionary Schnittstelle ermöglicht es den enthaltenen Schlüsseln und Werten, aufgezählt zu werden, aber sie impliziert keine bestimmte Sortierreihenfolge.

IDictionary Implementierungen fallen in drei Kategorien: schreibgeschützt, feste Größe, Variable-Größe. Ein schreibgeschütztes IDictionary-Objekt kann nicht geändert werden. Ein IDictionary Objekt mit fester Größe lässt das Hinzufügen oder Entfernen von Elementen nicht zu, ermöglicht aber die Änderung vorhandener Elemente. Ein objekt mit variabler Größe IDictionary ermöglicht das Hinzufügen, Entfernen und Ändern von Elementen.

Die foreach-Anweisung der C#-Sprache (For Each in Visual Basic) gibt ein Objekt des Typs der Elemente in der Auflistung zurück. Da jedes Element des IDictionary-Objekts ein Schlüssel-Wert-Paar ist, ist der Elementtyp nicht der Typ des Schlüssels oder des Typs des Werts. Stattdessen ist der Elementtyp DictionaryEntry. Zum Beispiel:

C#
foreach (DictionaryEntry de in myDictionary)
{
    //...
}

Die foreach-Anweisung ist ein Wrapper um den Enumerator, der nur das Lesen von, aber nicht das Schreiben in die Auflistung zulässt.

Hinweise für Ausführende

Die implementierende Klasse muss über eine Möglichkeit zum Vergleichen von Schlüsseln verfügen.

Eigenschaften

Count

Ruft die Anzahl der Elemente ab, die in der ICollectionenthalten sind.

(Geerbt von ICollection)
IsFixedSize

Ruft einen Wert ab, der angibt, ob das IDictionary -Objekt eine feste Größe hat.

IsReadOnly

Ruft einen Wert ab, der angibt, ob das IDictionary -Objekt schreibgeschützt ist.

IsSynchronized

Ruft einen Wert ab, der angibt, ob der Zugriff auf die ICollection synchronisiert wird (Threadsicher).

(Geerbt von ICollection)
Item[Object]

Ruft das Element mit dem angegebenen Schlüssel ab oder legt es fest.

Keys

Ruft ein ICollection -Objekt ab, das die Schlüssel des IDictionary -Objekts enthält.

SyncRoot

Ruft ein Objekt ab, das zum Synchronisieren des Zugriffs auf die ICollectionverwendet werden kann.

(Geerbt von ICollection)
Values

Ruft ein ICollection -Objekt ab, das die Werte im IDictionary -Objekt enthält.

Methoden

Add(Object, Object)

Fügt dem IDictionary-Objekt ein Element mit dem bereitgestellten Schlüssel und Wert hinzu.

Clear()

Entfernt alle Elemente aus dem IDictionary-Objekt.

Contains(Object)

Bestimmt, ob das IDictionary -Objekt ein Element mit dem angegebenen Schlüssel enthält.

CopyTo(Array, Int32)

Kopiert die Elemente des ICollection in einen Array, beginnend bei einem bestimmten Array Index.

(Geerbt von ICollection)
GetEnumerator()

Gibt ein IDictionaryEnumerator -Objekt für das IDictionary -Objekt zurück.

Remove(Object)

Entfernt das Element mit dem angegebenen Schlüssel aus dem IDictionary -Objekt.

Erweiterungsmethoden

Cast<TResult>(IEnumerable)

Wandelt die Elemente eines IEnumerable in den angegebenen Typ um.

OfType<TResult>(IEnumerable)

Filtert die Elemente einer IEnumerable basierend auf einem angegebenen Typ.

AsParallel(IEnumerable)

Aktiviert die Parallelisierung einer Abfrage.

AsQueryable(IEnumerable)

Wandelt eine IEnumerable in eine IQueryableum.

Gilt für:

Produkt Versionen
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

Weitere Informationen