UndoableDictionaryTKey, TValueRemove Method (TKey)

 Spotfire 14.3 API Reference
Removes the element with the specified key from the IDictionaryTKey, TValue.

Namespace:  Spotfire.Dxp.Framework.DocumentModel
Assembly:  Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
Copy
public bool Remove(
	TKey key
)

Parameters

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

Return Value

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

Implements

IDictionaryTKey, TValueRemove(TKey)
Exceptions
ExceptionCondition
ArgumentNullExceptionkey is .
NotSupportedExceptionThe IDictionaryTKey, TValue is read-only.
Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference

UndoableDictionaryTKey, TValue Class
Remove Overload
Spotfire.Dxp.Framework.DocumentModel Namespace