Contains Method
.NET Framework Class Library
IDictionary..::.Contains Method

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

Namespace:  System.Collections
Assembly:  mscorlib (in mscorlib.dll)
Visual Basic (Declaration)
Function Contains ( _
    key As Object _
) As Boolean
Visual Basic (Usage)
Dim instance As IDictionary
Dim key As Object
Dim returnValue As Boolean

returnValue = instance.Contains(key)
C#
bool Contains(
    Object key
)
Visual C++
bool Contains(
    Object^ key
)
JScript
function Contains(
    key : Object
) : 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.
ExceptionCondition
ArgumentNullException

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

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

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.

Visual Basic
Public Function Contains(ByVal key As Object) As Boolean Implements IDictionary.Contains
    Dim index As Integer
    Return TryGetIndexOfKey(key, index)
End Function
C#
public bool Contains(object key)
{
   Int32 index;
   return TryGetIndexOfKey(key, out index);
}
Visual C++
public:
    virtual bool Contains(Object^ key)
    {
        int index;
        return TryGetIndexOfKey(key, &index);
    }

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
Page view tracker