Base class for Preference implementations.
Inheritance Hierarchy
DedicatedThreadAccessible
Spotfire.Dxp.Framework.PreferencesPreferenceBase
Spotfire.Dxp.Application.ExtensionCustomPreference
Spotfire.Dxp.Application.UserPreferencesVisualizationPreferences
Namespace: Spotfire.Dxp.Framework.Preferences
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
public abstract class PreferenceBase : DedicatedThreadAccessible
The PreferenceBase type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | IsEmpty | Gets a value indicating whether this preference object only contains default property values or not.
|
Methods
| Name | Description | |
|---|---|---|
 | AddPreferenceT |
Call this method (in the constructor of your
concrete preference class implementation) to add a new property
to your preference class.
|
 | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnPropertyChanged | Override this method to perform desired operations when a
the value of a property has changed.
|
| Reset |
Resets all values that may explicitly have been given to the properties
of this preference on a user level basis through a calls to
Value. The effect of resetting a
property is that when the Value of it is queried, either the
group value or the default value will be returned.
|
| Save | Persists all changes to the properties of this preference object.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UndoChanges | Undoes any changes that may have been to all of the properties
of this preference, since it was last saved.
|
Events
| Name | Description | |
|---|---|---|
 | PropertyChanged | Occurs when one of the properties in this preference is changed.
|
Version Information
Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also