This topic has not yet been rated - Rate this topic

HybridDictionary.Remove Method

.NET Framework 4.5

Removes the entry with the specified key from the HybridDictionary.

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

'Declaration
Public Sub Remove ( _
	key As Object _
)

Parameters

key: Type: System.Object
The key of the entry to remove.

Implements

IDictionary.Remove(Object)

Exceptions

Exception	Condition
ArgumentNullException	key is Nothing.

Remarks

If the HybridDictionary does not contain an element with the specified key, the HybridDictionary remains unchanged. No exception is thrown.

If the collection is already stored in a Hashtable and the number of elements falls below the optimal size for a ListDictionary, the collection remains in the Hashtable to avoid the overhead of copying elements from the Hashtable back to a ListDictionary.

This method is an O(1) operation.

Examples

The following code example adds to and removes elements from a HybridDictionary.

C++

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

Public Class SamplesHybridDictionary   

   Public Shared Sub Main()

      ' Creates and initializes a new HybridDictionary. 
      Dim myCol As New HybridDictionary()
      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")
      myCol.Add("Plantain Bananas", "1.49")
      myCol.Add("Yellow Bananas", "0.79")
      myCol.Add("Strawberries", "3.33")
      myCol.Add("Cranberries", "5.98")
      myCol.Add("Navel Oranges", "1.29")
      myCol.Add("Grapes", "1.99")
      myCol.Add("Honeydew Melon", "0.59")
      myCol.Add("Seedless Watermelon", "0.49")
      myCol.Add("Pineapple", "1.49")
      myCol.Add("Nectarine", "1.99")
      myCol.Add("Plums", "1.69")
      myCol.Add("Peaches", "1.99")

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

      ' Deletes a key.
      myCol.Remove("Plums")
      Console.WriteLine("The collection contains the following elements after removing ""Plums"":")
      PrintKeysAndValues(myCol)

      ' Clears the entire collection.
      myCol.Clear()
      Console.WriteLine("The collection contains the following elements after it is cleared:")
      PrintKeysAndValues(myCol)

   End Sub 'Main

   Public Shared Sub PrintKeysAndValues(myCol As IDictionary)

      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 'SamplesHybridDictionary 


'This code produces the following output. 
' 
'Initial contents of the HybridDictionary: 
'   KEY                       VALUE 
'   Seedless Watermelon       0.49 
'   Nectarine                 1.99 
'   Cranberries               5.98 
'   Plantain Bananas          1.49 
'   Honeydew Melon            0.59 
'   Pineapple                 1.49 
'   Strawberries              3.33 
'   Grapes                    1.99 
'   Braeburn Apples           1.49 
'   Peaches                   1.99 
'   Red Delicious Apples      0.99 
'   Golden Delicious Apples   1.29 
'   Yellow Bananas            0.79 
'   Granny Smith Apples       0.89 
'   Gala Apples               1.49 
'   Plums                     1.69 
'   Navel Oranges             1.29 
'   Fuji Apples               1.29 
' 
'The collection contains the following elements after removing "Plums": 
'   KEY                       VALUE 
'   Seedless Watermelon       0.49 
'   Nectarine                 1.99 
'   Cranberries               5.98 
'   Plantain Bananas          1.49 
'   Honeydew Melon            0.59 
'   Pineapple                 1.49 
'   Strawberries              3.33 
'   Grapes                    1.99 
'   Braeburn Apples           1.49 
'   Peaches                   1.99 
'   Red Delicious Apples      0.99 
'   Golden Delicious Apples   1.29 
'   Yellow Bananas            0.79 
'   Granny Smith Apples       0.89 
'   Gala Apples               1.49 
'   Navel Oranges             1.29 
'   Fuji Apples               1.29 
' 
'The collection contains the following elements after it is cleared: 
'   KEY                       VALUE 
'

Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Reference

HybridDictionary Class

System.Collections.Specialized Namespace

Add

IDictionary.Remove

Other Resources

Performing Culture-Insensitive String Operations

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)