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

Definice

Obor názvů:

System.Collections.Generic

Sestavení:

System.Collections.dll

Zdroj:

Dictionary.cs

Získá nebo nastaví hodnotu přidruženou k zadanému klíči.

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íč hodnoty, kterou chcete získat nebo nastavit.

Hodnota vlastnosti

TValue

Hodnota přidružená k zadanému klíči. Pokud zadaný klíč není nalezen, operace get vyvolá KeyNotFoundExceptiona operace set vytvoří nový prvek se zadaným klíčem.

Implementuje

Item[TKey]

Výjimky

ArgumentNullException

key je null.

KeyNotFoundException

Vlastnost se načte a key v kolekci neexistuje.

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 příklad kódu je součástí většího příkladu Dictionary<TKey,TValue> pro třídu. openWith je název slovníku použitého v tomto příkladu.

// Create a new dictionary of strings, with string keys.
//
Dictionary<String^, String^>^ openWith =
    gcnew Dictionary<String^, String^>();

// Add some elements to the dictionary. 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");

// The Add method throws an exception if the new key is
// already in the dictionary.
try
{
    openWith->Add("txt", "winword.exe");
}
catch (ArgumentException^)
{
    Console::WriteLine("An element with Key = \"txt\" already exists.");
}

// Create a new dictionary of strings, with string keys.
//
Dictionary<string, string> openWith =
    new Dictionary<string, string>();

// Add some elements to the dictionary. 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");

// The Add method throws an exception if the new key is
// already in the dictionary.
try
{
    openWith.Add("txt", "winword.exe");
}
catch (ArgumentException)
{
    Console.WriteLine("An element with Key = \"txt\" already exists.");
}

' Create a new dictionary of strings, with string keys.
'
Dim openWith As New Dictionary(Of String, String)

' Add some elements to the dictionary. 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")

' The Add method throws an exception if the new key is 
' already in the dictionary.
Try
    openWith.Add("txt", "winword.exe")
Catch 
    Console.WriteLine("An element with Key = ""txt"" already exists.")
End Try

// 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 jazyka C#: 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 v objektu Dictionary<TKey,TValue>. Když nastavíte hodnotu vlastnosti a klíč je v Dictionary<TKey,TValue>, nahradí se hodnota přidružená k danému klíči přiřazenou hodnotou. Pokud klíč není v Dictionary<TKey,TValue>, klíč a hodnota se přidají do slovníku. Naproti tomu Add metoda neupravuje existující prvky.

Klíč nemůže být null, ale hodnota může být, pokud je typ TValue hodnoty odkazovým typem.

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

Získání nebo nastavení hodnoty této vlastnosti se blíží operaci O(1).

Viz také

• Add(TKey, TValue)