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: 65.0.19510.3242 (65.0.19510.3242)
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
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