IDictionary<TKey,TValue>.Item[TKey] Vlastnost

Definice

Obor názvů:

System.Collections.Generic

Sestavení:

System.Runtime.dll

Získá nebo nastaví element se zadaným klíčem.

public:
 property TValue default[TKey] { TValue get(TKey key); void set(TKey key, TValue value); };

public TValue this[TKey key] { get; set; }

member this.Item('Key) : 'Value with get, set

Default Public Property Item(key As TKey) As TValue

Parametry

key

TKey

Klíč elementu, který chcete získat nebo nastavit.

Hodnota vlastnosti

TValue

Element se zadaným klíčem.

Výjimky

ArgumentNullException

key je null.

KeyNotFoundException

Vlastnost se načte a key nebyla nalezena.

NotSupportedException

Vlastnost je nastavená a IDictionary<TKey,TValue> je jen pro čtení.

Příklady

Následující příklad kódu používá Item[] vlastnost (indexer v jazyce C#) k načtení hodnot, což demonstruje, že KeyNotFoundException je vyvolána, když není k dispozici požadovaný klíč, a ukazuje, že hodnota přidružená ke klíči může být nahrazena.

Příklad také ukazuje, jak použít metodu TryGetValue jako efektivnější způsob načítání hodnot, pokud program často musí vyzkoušet klíčové hodnoty, které nejsou ve slovníku.

Tento kód je součástí většího příkladu, který lze zkompilovat a spustit. Viz třída System.Collections.Generic.IDictionary<TKey,TValue>.

// The Item property is another name for the indexer, so you
// can omit its name when accessing elements.
Console::WriteLine("For key = \"rtf\", value = {0}.",
    openWith["rtf"]);

// The indexer can be used to change the value associated
// with a key.
openWith["rtf"] = "winword.exe";
Console::WriteLine("For key = \"rtf\", value = {0}.",
    openWith["rtf"]);

// If a key does not exist, setting the indexer for that key
// adds a new key/value pair.
openWith["doc"] = "winword.exe";

// The Item property is another name for the indexer, so you
// can omit its name when accessing elements.
Console.WriteLine("For key = \"rtf\", value = {0}.",
    openWith["rtf"]);

// The indexer can be used to change the value associated
// with a key.
openWith["rtf"] = "winword.exe";
Console.WriteLine("For key = \"rtf\", value = {0}.",
    openWith["rtf"]);

// If a key does not exist, setting the indexer for that key
// adds a new key/value pair.
openWith["doc"] = "winword.exe";

' The Item property is the default property, so you 
' can omit its name when accessing elements. 
Console.WriteLine("For key = ""rtf"", value = {0}.", _
    openWith("rtf"))

' The default Item property can be used to change the value
' associated with a key.
openWith("rtf") = "winword.exe"
Console.WriteLine("For key = ""rtf"", value = {0}.", _
    openWith("rtf"))

' If a key does not exist, setting the default item property
' for that key adds a new key/value pair.
openWith("doc") = "winword.exe"

// The indexer throws an exception if the requested key is
// not in the dictionary.
try
{
    Console::WriteLine("For key = \"tif\", value = {0}.",
        openWith["tif"]);
}
catch (KeyNotFoundException^)
{
    Console::WriteLine("Key = \"tif\" is not found.");
}

// The indexer throws an exception if the requested key is
// not in the dictionary.
try
{
    Console.WriteLine("For key = \"tif\", value = {0}.",
        openWith["tif"]);
}
catch (KeyNotFoundException)
{
    Console.WriteLine("Key = \"tif\" is not found.");
}

' The default Item property throws an exception if the requested
' key is not in the dictionary.
Try
    Console.WriteLine("For key = ""tif"", value = {0}.", _
        openWith("tif"))
Catch 
    Console.WriteLine("Key = ""tif"" is not found.")
End Try

// When a program often has to try keys that turn out not to
// be in the dictionary, TryGetValue can be a more efficient
// way to retrieve values.
String^ value = "";
if (openWith->TryGetValue("tif", value))
{
    Console::WriteLine("For key = \"tif\", value = {0}.", value);
}
else
{
    Console::WriteLine("Key = \"tif\" is not found.");
}

// When a program often has to try keys that turn out not to
// be in the dictionary, TryGetValue can be a more efficient
// way to retrieve values.
string value = "";
if (openWith.TryGetValue("tif", out value))
{
    Console.WriteLine("For key = \"tif\", value = {0}.", value);
}
else
{
    Console.WriteLine("Key = \"tif\" is not found.");
}

' When a program often has to try keys that turn out not to
' be in the dictionary, TryGetValue can be a more efficient 
' way to retrieve values.
Dim value As String = ""
If openWith.TryGetValue("tif", value) Then
    Console.WriteLine("For key = ""tif"", value = {0}.", value)
Else
    Console.WriteLine("Key = ""tif"" is not found.")
End If

Poznámky

Tato vlastnost umožňuje přístup ke konkrétnímu prvku v kolekci pomocí následující syntaxe: myCollection[key] (myCollection(key) v jazyce Visual Basic).

Vlastnost můžete také použít Item[] k přidání nových prvků nastavením hodnoty klíče, který neexistuje ve slovníku, myCollection["myNonexistentKey"] = myValue například v jazyce C# (myCollection("myNonexistentKey") = myValue v jazyce Visual Basic). Pokud však zadaný klíč již ve slovníku existuje, nastavení Item[] vlastnosti přepíše starou hodnotu. Naproti tomu Add metoda neupravuje existující prvky.

Implementace se mohou lišit v tom, jak určují rovnost objektů; Třída například List<T> používá , zatímco Dictionary<TKey,TValue> třída umožňuje uživateli zadat implementaciIComparer<T>, která se má použít Comparer<T>.Defaultpro porovnání klíčů.

Jazyk C# používá klíčové slovo toto k definování indexerů místo implementace Item[] vlastnosti. Visual Basic se implementuje Item[] jako výchozí vlastnost, která poskytuje stejné funkce indexování.

Implementace se můžou lišit v tom, jestli umožňují key být null.

Viz také

• Add(TKey, TValue)
• ContainsKey(TKey)
• IsReadOnly