PreferenceManager Class

Spotfire 14.2 API Reference
Provides functionality to retrieve and set preferences for the currently logged on user. There is only one object of this type available in the application. This instance is registered as a top-level service and can be accessed through one of the service provider methods. New instances of this type cannot be created.
Inheritance Hierarchy

SystemObject
  DedicatedThreadAccessible
    DedicatedThreadService
      Spotfire.Dxp.Framework.PreferencesPreferenceManager

Namespace:  Spotfire.Dxp.Framework.Preferences
Assembly:  Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
public sealed class PreferenceManager : DedicatedThreadService, 
	IDisposable

The PreferenceManager type exposes the following members.

Properties

  NameDescription
Public propertyEnabled Obsolete.
Gets whether or not the use of preferences is enabled.
Top
Methods

  NameDescription
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPreferenceT
Gets a preference that has been registered with the framework. Note that a preference must always have been registered during the initialization phase of an add-in for it to be returned by this method.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodPreferenceExistsT
Determines whether or not a preferences of type T exists, that is, has been registered with the framework.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference