Remove Method (TKey)
Collapse the table of content
Expand the table of content

IDictionary<TKey, TValue>.Remove Method (TKey)

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

Removes the element with the specified key from the IDictionary<TKey, TValue>.

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

bool Remove(
	TKey key
)

Parameters

key
Type: TKey
The key of the element to remove.

Return Value

Type: System.Boolean
true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original IDictionary<TKey, TValue>.

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

The following code example shows how to remove a key/value pair from a dictionary using the Remove method.

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


// Use the Remove method to remove a key/value pair.
outputBlock.Text += "\nRemove(\"doc\")" + "\n";
openWith.Remove("doc");

if (!openWith.ContainsKey("doc"))
{
   outputBlock.Text += "Key \"doc\" is not found." + "\n";
}


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Show:
© 2016 Microsoft