PreferenceObjectService.Remove(T) Method

PreferenceObjectService Remove T Method

TIBCO Spotfire 6.0 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: 13.19.7018.3940 (13.19.7018.3940)

Syntax

C++

Copy to Clipboard Print

public bool Remove<T>(
	PreferenceObject<T> preferenceObject
)

public bool Remove<T>(
	PreferenceObject<T> preferenceObject
)

Parameters

preferenceObject: Type: Spotfire.Dxp.Framework.Preferences PreferenceObject T
The preference object to remove.

Type Parameters

T

Return Value

Type: Boolean
true if the object was found and removed; otherwise false.

Exceptions

Exception	Condition
System ArgumentNullException	If preferenceObject is null.
System NotSupportedException	If the preference object is readonly, that is, the object doesn't belong to the users own defined set of objects.
System ArgumentException	If the preference class given in preferenceObject doesn't exist.