UndoableDictionary(TKey, TValue).Remove Method (TKey)

UndoableDictionary TKey, TValue Remove Method (TKey)

TIBCO Spotfire 7.0 API Reference

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

Namespace: Spotfire.Dxp.Framework.DocumentModel
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 18.10.8513.5432 (18.10.8513.5432)

Syntax

C++

Copy to Clipboard Print

public bool Remove(
	TKey key
)

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 IDictionary TKey, TValue .

Implements

IDictionary TKey, TValue Remove(TKey)

Exceptions

Exception	Condition
System ArgumentNullException	key is null.
System NotSupportedException	The IDictionary TKey, TValue is read-only.

Version Information

Supported in: 7.0, 6.5, 6.0, 5.5, 5.0