Finds the one and only PreferenceObject T in the class
defined by className that has the same value as
value and the id as objectId. If
no such object is not found, the first object in the class that has
the same value as T will be returned even if it
doesn't have the same id as objectId. If no object with
the same value as T is found, a default object
defined for the class will be returned.
Namespace: Spotfire.Dxp.Framework.PreferencesAssembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 18.10.8513.5432 (18.10.8513.5432)
Syntax
Parameters
- className
- Type: System String
The name of the preference class for which the object will be found.
- value
- Type: T
The value of the preference object to compare with.
- objectId
- Type: Spotfire.Dxp.Framework.Preferences PreferenceObjectIdentifier
The id of the preference object to compare with.
Type Parameters
- T
- The type of the preference value for this preference object.
Return Value
Type: PreferenceObjectIdentifierThe preference object that match the class, value and id given by className, value, and objectId. If no exact match is found, a best match is performed (see above).
Exceptions
Exception | Condition |
---|---|
System ArgumentNullException | If value, className or objectId is null. |
System ArgumentException | If className is an empty string, if the preference class is not defined, or if T is of wrong type. |
Version Information
See Also