PreferenceObjectServiceRemoveT Method

Spotfire 14.7 API Reference
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: 69.0.21424.2902 (69.0.21424.2902)
Syntax
C#
Copy
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: Boolean
true if the object was found and removed; otherwise false.
Exceptions
ExceptionCondition
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.7, 14.6, 14.5, 14.4, 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

PreferenceObjectService Class
Spotfire.Dxp.Framework.Preferences Namespace