Initializes a new instance of type PreferenceProperty T .
Namespace: Spotfire.Dxp.Framework.PreferencesAssembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 18.10.8513.5432 (18.10.8513.5432)
Syntax
Parameters
- name
- Type: System String
The name of the property.
- version
- Type: System String
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.Preferences PreferencePersistenceScope
Defines if the preference should be persisted locally or on server.
- usage
- Type: Spotfire.Dxp.Framework.Preferences PreferenceUsage
The usage of the property, for example if it is possible to set user group values for the property.
- defaultValue
- Type: T
A default value for the property.
Exceptions
Exception | Condition |
---|---|
System ArgumentNullException | If either of the parameters name, version, or defaultValue is null. |
System ArgumentException | If either of the parameters name or version is an empty string. |
Version Information
See Also