Gets one specific PreferenceObjectT with the identity
defined by objectId. The retrieval is performed
according to the following sets of rules:
If the requested preference object is found, return it.Else, if there is a user defined default object, return it.Else, if there is a group level defined default object,
return it. If the user is a member of more than one group, an
individual group order determines which default preference object
to use.
Else, if there is an application default object, return it.Else, throw exception.
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#
public PreferenceObject<T> GetObject<T>( PreferenceObjectIdentifier objectId )
Parameters
- objectId
- Type: Spotfire.Dxp.Framework.PreferencesPreferenceObjectIdentifier
The id of the object to be returned.
Type Parameters
- T
Return Value
Type: PreferenceObjectTThe preference object identified by objectId. If no object matches the id, a default object defined for the preference class is returned.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | If objectId is null. |
| ArgumentException | If T is of wrong type (differs from the type that has previously been registered with the given id), if the preference class is not defined, or if no object to return was found (including a default object). |
Version Information
See Also