IDictionary<TKey,TValue>.Item[TKey] Propriété

Définition

Espace de noms:

System.Collections.Generic

Assembly:

System.Runtime.dll

Obtient ou définit l'élément à l'aide de la clé spécifiée.

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

Paramètres

key

TKey

Clé de l'élément à obtenir ou définir.

Valeur de propriété

TValue

Élément correspondant à la clé spécifiée.

Exceptions

ArgumentNullException

key a la valeur null.

KeyNotFoundException

La propriété est récupérée et key est introuvable.

NotSupportedException

La propriété est définie et IDictionary<TKey,TValue> est en lecture seule.

Exemples

L’exemple de code suivant utilise la Item[] propriété (l’indexeur en C#) pour récupérer des valeurs, démontrant qu’un KeyNotFoundException est levée lorsqu’une clé demandée n’est pas présente et montrant que la valeur associée à une clé peut être remplacée.

L’exemple montre également comment utiliser la TryGetValue méthode comme un moyen plus efficace de récupérer des valeurs si un programme doit souvent essayer des valeurs clés qui ne figurent pas dans le dictionnaire.

Ce code fait partie d’un exemple plus large qui peut être compilé et exécuté. Consultez 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

Remarques

Cette propriété permet d’accéder à un élément spécifique de la collection à l’aide de la syntaxe suivante : myCollection[key] (myCollection(key) en Visual Basic).

Vous pouvez également utiliser la Item[] propriété pour ajouter de nouveaux éléments en définissant la valeur d’une clé qui n’existe pas dans le dictionnaire, par exemple, myCollection["myNonexistentKey"] = myValue en C# (myCollection("myNonexistentKey") = myValue en Visual Basic). Toutefois, si la clé spécifiée existe déjà dans le dictionnaire, la définition de la Item[] propriété remplace l’ancienne valeur. En revanche, la Add méthode ne modifie pas les éléments existants.

Les implémentations peuvent varier dans la façon dont elles déterminent l’égalité des objets ; par exemple, la List<T> classe utilise Comparer<T>.Default, tandis que la Dictionary<TKey,TValue> classe permet à l’utilisateur de spécifier l’implémentation IComparer<T> à utiliser pour comparer des clés.

Le langage C# utilise cette mot clé pour définir les indexeurs au lieu d’implémenter la Item[] propriété. Visual Basic implémente Item[] comme propriété par défaut, ce qui fournit les mêmes fonctionnalités d'indexation.

Les implémentations peuvent varier selon qu’elles permettent key d’être null.

Voir aussi

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