Initializes a new instance of type PreferencePropertyT.
Namespace: Spotfire.Dxp.Framework.Preferences
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 23.18.9504.3877 (23.18.9504.3877)
Syntax
C#
public PreferenceProperty( string name, string version, PreferencePersistenceScope persistenceScope, PreferenceUsage usage )
Parameters
- name
- Type: SystemString
The name of the property. - version
- Type: SystemString
A version number for the property, for example "1.0". If the data type of the property changes, or any other change that will cause the deserialization of the persisted property value to fail is inflicted upon the property, the version number must be increased. - persistenceScope
- Type: Spotfire.Dxp.Framework.PreferencesPreferencePersistenceScope
Defines if the preference should be persisted locally or on server. - usage
- Type: Spotfire.Dxp.Framework.PreferencesPreferenceUsage
The usage of the property, for example if it is possible to set user group values for the property.
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | If either of the parameters name or version is null. |
ArgumentException | If either of the parameters name or version is an empty string. |
Version Information
See Also