IDictionary.Contains Method (Object)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Determines whether the IDictionary object contains an element with the specified key.

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

Function Contains (
	key As Object
) As Boolean

Parameters

key
Type: System.Object

The key to locate in the IDictionary object.

Return Value

Type: System.Boolean

true if the IDictionary contains an element with the key; otherwise, false.

Exception Condition
ArgumentNullException

key is null.

Implementations can vary in whether they allow the key to be null.

Starting with the .NET Framework 2.0, this method uses the collection’s objects’ Equals and CompareTo methods on item to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the Equals and CompareTo methods of the item parameter on the objects in the collection.

The following code example demonstrates how to implement the Contains method. This code example is part of a larger example provided for the IDictionary class.

Public Function Contains(ByVal key As Object) As Boolean Implements IDictionary.Contains
    Dim index As Integer
    Return TryGetIndexOfKey(key, index)
End Function

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show: