PreferencePropertyT Constructor (String, String, PreferencePersistenceScope, PreferenceUsage, T, T, T) TIBCO Spotfire 7.6 API Reference

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

C#
public PreferenceProperty(
	string name,
	string version,
	PreferencePersistenceScope persistenceScope,
	PreferenceUsage usage,
	T defaultValue,
	T minimum,
	T maximum
)

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.
defaultValue
Type: T
A default value for the property.
minimum
Type: T
Minimum value allowed for the property. The value of the property will be validated to this minimum when it is set.
maximum
Type: T
Maximum value allowed for the property. The value of the property will be validated to this minimum when it is set.
Exceptions

ExceptionCondition
ArgumentNullException If either of the parameters name, version, or defaultValue is null.
ArgumentException If either of the parameters name or version is an empty string.
Version Information

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference