IDictionary<TKey, TValue>.Remove Method (TKey)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Removes the element with the specified key from the IDictionary<TKey, TValue>.
Namespace: System.Collections.Generic
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Function Remove ( _
key As TKey _
) As Boolean
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>.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | key is nulla null reference (Nothing in Visual Basic). |
| NotSupportedException | The IDictionary<TKey, TValue> is read-only. |
Remarks
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.
Examples
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 &= vbLf + "Remove(""doc"")" & vbCrLf
openWith.Remove("doc")
If Not openWith.ContainsKey("doc") Then
outputBlock.Text &= "Key ""doc"" is not found." & vbCrLf
End If
// 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";
}
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Xbox 360, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.