PreferencePropertyT Constructor (String, String, PreferencePersistenceScope, PreferenceUsage, PreferencePropertyTDefaultValueCalculatorCallback)

Spotfire 14.3 API Reference

Initializes a new instance of type PreferencePropertyT.

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

Syntax

Copy

public PreferenceProperty(
	string name,
	string version,
	PreferencePersistenceScope persistenceScope,
	PreferenceUsage usage,
	PreferencePropertyTDefaultValueCalculatorCallback defaultValueCalculator
)

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.
defaultValueCalculator: Type: Spotfire.Dxp.Framework.PreferencesPreferencePropertyTDefaultValueCalculatorCallback
A delegate that provides the default value of the property.

Exceptions

Exception	Condition
ArgumentNullException	If either of the parameters name, version, or defaultValueCalculator is null.
ArgumentException	If either of the parameters name or version is an empty string.

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

Reference

PreferencePropertyT Class

PreferencePropertyT Overload

Spotfire.Dxp.Framework.Preferences Namespace