PreferenceObjectServiceAddApplicationDefaultT Method TIBCO Spotfire 7.6 API Reference
Adds a PreferenceObjectT as the application default preference object.

Namespace: Spotfire.Dxp.Framework.Preferences
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
Copy
public void AddApplicationDefault<T>(
	PreferenceObject<T> preferenceObject
)

Parameters

preferenceObject
Type: Spotfire.Dxp.Framework.PreferencesPreferenceObjectT
The preference object to add.

Type Parameters

T
The type of the preference value for this preference object.
Exceptions
ExceptionCondition
ArgumentNullException If preferenceObject is null.
ArgumentException If T is of wrong type, that is, does not match the type of objects previously registered.
InvalidOperationException If an object already is marked as application default.
Remarks
A preference object added through a call to this method will be marked as the default object for the class to which it belongs and returned from query methods such as GetObjectT(PreferenceObjectIdentifier) in cases where no match can be found. The default object is also marked as read only and can therefore not be deleted or have its value changed through the interface of this class. In addition default objects are never persisted, for example stored on the local computer or be on the server.

A default object is typically registered with this class during the initialization phase of application add-ins.

Version Information

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference

PreferenceObjectService Class
Spotfire.Dxp.Framework.Preferences Namespace