Determines whether the ListDictionary contains a specific key.

[Visual Basic]
Public Overridable Function Contains( _
   ByVal key As Object _
) As Boolean Implements IDictionary.Contains
[C#]
public virtual bool Contains(
   object key
);
[C++]
public: virtual bool Contains(
   Object* key
);
[JScript]
public function Contains(
   key : Object
) : Boolean;

Parameters

key

The key to locate in the ListDictionary.

Return Value

true if the ListDictionary contains an entry with the specified key; otherwise, false.

Implements

IDictionary.Contains

Exceptions

Remarks

This is an O(n) operation, where n is Count.

Example

[Visual Basic] 
' The following code example searches for an element in a ListDictionary.

Imports System
Imports System.Collections
Imports System.Collections.Specialized

Public Class SamplesListDictionary   

   Public Shared Sub Main()

      ' Creates and initializes a new ListDictionary.
      Dim myCol As New ListDictionary()
      myCol.Add("Braeburn Apples", "1.49")
      myCol.Add("Fuji Apples", "1.29")
      myCol.Add("Gala Apples", "1.49")
      myCol.Add("Golden Delicious Apples", "1.29")
      myCol.Add("Granny Smith Apples", "0.89")
      myCol.Add("Red Delicious Apples", "0.99")

      ' Displays the values in the ListDictionary in three different ways.
      Console.WriteLine("Initial contents of the ListDictionary:")
      PrintKeysAndValues(myCol)

      ' Searches for a key.
      If myCol.Contains("Kiwis") Then
         Console.WriteLine("The collection contains the key ""Kiwis"".")
      Else
         Console.WriteLine("The collection does not contain the key ""Kiwis"".")
      End If
      Console.WriteLine()

   End Sub 'Main

   Public Shared Sub PrintKeysAndValues(myCol As IEnumerable)
      Dim myEnumerator As IEnumerator = myCol.GetEnumerator()

      Console.WriteLine("   KEY                       VALUE")
      Dim de As DictionaryEntry
      For Each de In  myCol
         Console.WriteLine("   {0,-25} {1}", de.Key, de.Value)
      Next de
      Console.WriteLine()

   End Sub 'PrintKeysAndValues

End Class 'SamplesListDictionary 


'This code produces the following output.
'
'Initial contents of the ListDictionary:
'   KEY                       VALUE
'   Braeburn Apples           1.49
'   Fuji Apples               1.29
'   Gala Apples               1.49
'   Golden Delicious Apples   1.29
'   Granny Smith Apples       0.89
'   Red Delicious Apples      0.99
'
'The collection does not contain the key "Kiwis".


[C#] 
// The following code example searches for an element in a ListDictionary.

using System;
using System.Collections;
using System.Collections.Specialized;

public class SamplesListDictionary  {

   public static void Main()  {

      // Creates and initializes a new ListDictionary.
      ListDictionary myCol = new ListDictionary();
      myCol.Add( "Braeburn Apples", "1.49" );
      myCol.Add( "Fuji Apples", "1.29" );
      myCol.Add( "Gala Apples", "1.49" );
      myCol.Add( "Golden Delicious Apples", "1.29" );
      myCol.Add( "Granny Smith Apples", "0.89" );
      myCol.Add( "Red Delicious Apples", "0.99" );

      // Displays the values in the ListDictionary in three different ways.
      Console.WriteLine( "Initial contents of the ListDictionary:" );
      PrintKeysAndValues( myCol );

      // Searches for a key.
      if ( myCol.Contains( "Kiwis" ) )
         Console.WriteLine( "The collection contains the key \"Kiwis\"." );
      else
         Console.WriteLine( "The collection does not contain the key \"Kiwis\"." );
      Console.WriteLine();

   }

   public static void PrintKeysAndValues( IEnumerable myCol )  {
      IEnumerator myEnumerator = myCol.GetEnumerator();
      Console.WriteLine( "   KEY                       VALUE" );
      foreach ( DictionaryEntry de in myCol )
         Console.WriteLine( "   {0,-25} {1}", de.Key, de.Value );
      Console.WriteLine();
   }

}


/*
This code produces the following output.

Initial contents of the ListDictionary:
   KEY                       VALUE
   Braeburn Apples           1.49
   Fuji Apples               1.29
   Gala Apples               1.49
   Golden Delicious Apples   1.29
   Granny Smith Apples       0.89
   Red Delicious Apples      0.99

The collection does not contain the key "Kiwis".

*/


[C++] 
// The following code example searches for an element in a ListDictionary.

#using <mscorlib.dll>
#using <System.dll>

using namespace System;
using namespace System::Collections;
using namespace System::Collections::Specialized;

void PrintKeysAndValues(IEnumerable* myCol) {
   Console::WriteLine(S"   KEY                       VALUE");
   IEnumerator* myEnum = myCol->GetEnumerator();
   while (myEnum->MoveNext()) {
      DictionaryEntry* de = __try_cast<DictionaryEntry*>(myEnum->Current);
      Console::WriteLine(S"   {0, -25} {1}", de->Key, de->Value);
   }
   Console::WriteLine();
}

int main() {
   // Creates and initializes a new ListDictionary.
   ListDictionary* myCol = new ListDictionary();
   myCol->Add(S"Braeburn Apples", S"1.49");
   myCol->Add(S"Fuji Apples", S"1.29");
   myCol->Add(S"Gala Apples", S"1.49");
   myCol->Add(S"Golden Delicious Apples", S"1.29");
   myCol->Add(S"Granny Smith Apples", S"0.89");
   myCol->Add(S"Red Delicious Apples", S"0.99");

   // Displays the values in the ListDictionary in three different ways.
   Console::WriteLine(S"Initial contents of the ListDictionary:");
   PrintKeysAndValues(myCol);

   // Searches for a key.
   if (myCol->Contains(S"Kiwis"))
      Console::WriteLine(S"The collection contains the key \"Kiwis\".");
   else
      Console::WriteLine(S"The collection does not contain the key \"Kiwis\".");
   Console::WriteLine();
}

/*
This code produces the following output.

Initial contents of the ListDictionary:
KEY                       VALUE
Braeburn Apples           1.49
Fuji Apples               1.29
Gala Apples               1.49
Golden Delicious Apples   1.29
Granny Smith Apples       0.89
Red Delicious Apples      0.99

The collection does not contain the key S"Kiwis".

*/

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework - Windows CE .NET

See Also

ListDictionary Class | ListDictionary Members | System.Collections.Specialized Namespace | IDictionary | Performing Culture-Insensitive String Operations