IDictionary<(Of <(TKey, TValue>)>).ContainsKey Method

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Determines whether the IDictionary<(Of <(TKey, TValue>)>) contains an element with the specified key.

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

Syntax

Function ContainsKey ( _
    key As TKey _
) As Boolean
bool ContainsKey(
    TKey key
)

Parameters

Return Value

Type: System..::.Boolean
true if the IDictionary<(Of <(TKey, TValue>)>) contains an element with the key; otherwise, false.

Exceptions

Exception Condition
ArgumentNullException

key is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

Implementations can vary in how they determine equality of objects; for example, the List<(Of <(T>)>) class uses Comparer<(Of <(T>)>)..::.Default, whereas the Dictionary<(Of <(TKey, TValue>)>) class allows the user to specify the IComparer<(Of <(T>)>) implementation to use for comparing keys.

Implementations can vary in whether they allow key to be nullNothingnullptra null reference (Nothing in Visual Basic).

Examples

The following code example shows how to use the ContainsKey method to test whether a key exists prior to calling the Add method. It also shows how to use the TryGetValue method, which can be a more efficient way to retrieve values if a program frequently tries key values that are not in the dictionary. Finally, it shows how to insert items using Item property (the indexer in C#).

This code is part of a larger example that can be compiled and executed. See System.Collections.Generic..::.IDictionary<(Of <(TKey, TValue>)>).

' ContainsKey can be used to test keys before inserting 
' them.
If Not openWith.ContainsKey("ht") Then
   openWith.Add("ht", "hypertrm.exe")
   outputBlock.Text &= String.Format("Value added for key = ""ht"": {0}", _
       openWith("ht")) & vbCrLf
End If


...


' 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
   outputBlock.Text &= String.Format("For key = ""tif"", value = {0}.", value) & vbCrLf
Else
   outputBlock.Text &= "Key = ""tif"" is not found." & vbCrLf
End If


...


' The default Item property throws an exception if the requested
' key is not in the dictionary.
Try
   outputBlock.Text &= String.Format("For key = ""tif"", value = {0}.", _
       openWith("tif")) & vbCrLf
Catch
   outputBlock.Text &= "Key = ""tif"" is not found." & vbCrLf
End Try
// ContainsKey can be used to test keys before inserting 
// them.
if (!openWith.ContainsKey("ht"))
{
   openWith.Add("ht", "hypertrm.exe");
   outputBlock.Text += String.Format("Value added for key = \"ht\": {0}",
       openWith["ht"]) + "\n";
}


...


// 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))
{
   outputBlock.Text += String.Format("For key = \"tif\", value = {0}.", value) + "\n";
}
else
{
   outputBlock.Text += "Key = \"tif\" is not found." + "\n";
}


...


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

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

IDictionary<(Of <(TKey, TValue>)>) Interface

System.Collections.Generic Namespace