Removes a preference object from the current users own defined set
of objects.
Namespace: Spotfire.Dxp.Framework.Preferences
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 23.18.9504.3877 (23.18.9504.3877)
Syntax
C#
public bool Remove<T>( PreferenceObject<T> preferenceObject )
Parameters
- preferenceObject
- Type: Spotfire.Dxp.Framework.PreferencesPreferenceObjectT
The preference object to remove.
Type Parameters
- T
Return Value
Type: Booleantrue if the object was found and removed; otherwise false.
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | If preferenceObject is null. |
NotSupportedException | If the preference object is readonly, that is, the object doesn't belong to the users own defined set of objects. |
ArgumentException | If the preference class given in preferenceObject doesn't exist. |
Version Information
See Also