PreferenceObjectService.AddApplicationDefault(T) Method

PreferenceObjectService AddApplicationDefault T Method

TIBCO Spotfire 6.0 API Reference

Adds a PreferenceObject T as the application default preference object.

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 void AddApplicationDefault<T>(
	PreferenceObject<T> preferenceObject
)

public void AddApplicationDefault<T>(
	PreferenceObject<T> preferenceObject
)

Parameters

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

Type Parameters

T: The type of the preference value for this preference object.

Exceptions

Exception	Condition
System ArgumentNullException	If preferenceObject is null.
System ArgumentException	If T is of wrong type, that is, does not match the type of objects previously registered.
System 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 GetObject T (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.