PreferenceProperty(T) Constructor (String, String, PreferencePersistenceScope, PreferenceUsage, T)

PreferenceProperty T Constructor (String, String, PreferencePersistenceScope, PreferenceUsage, T)

TIBCO Spotfire 6.0 API Reference

Initializes a new instance of type PreferenceProperty T .

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

Syntax

C++

Copy to Clipboard Print

public PreferenceProperty(
	string name,
	string version,
	PreferencePersistenceScope persistenceScope,
	PreferenceUsage usage,
	T defaultValue
)

public PreferenceProperty(
	string name,
	string version,
	PreferencePersistenceScope persistenceScope,
	PreferenceUsage usage,
	T defaultValue
)

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.