PreferenceProperty T  Members TIBCO Spotfire 6.0 API Reference
The PreferenceProperty T  type exposes the following members.
Constructors

  NameDescription
Public methodPreferenceProperty T (String, String, PreferencePersistenceScope, PreferenceUsage)
Public methodPreferenceProperty T (String, String, PreferencePersistenceScope, PreferenceUsage, PreferenceProperty T  DefaultValueCalculatorCallback)
Public methodPreferenceProperty T (String, String, PreferencePersistenceScope, PreferenceUsage, T)
Public methodPreferenceProperty T (String, String, PreferencePersistenceScope, PreferenceUsage, T, T)
Public methodPreferenceProperty T (String, String, PreferencePersistenceScope, PreferenceUsage, PreferenceProperty T  DefaultValueCalculatorCallback, T, T)
Public methodPreferenceProperty T (String, String, PreferencePersistenceScope, PreferenceUsage, T, T, T)
Back to Top
Methods

  NameDescription
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOnValueChanged
Use this method to report changes that may have occurred inside of an mutable property value. The Save  must be used to persist the changes.
Public methodReset
Resets any value that may explicitly have been given to this property on a user level basis through a call to Value. The effect of resetting a property is that when the Value of it is queried, either the group value or the default value will be returned.
(Inherited from PreferencePropertyBase.)
Public methodUndoChanges
Undoes any changes that may have been to the value of this property since it was last saved.
(Inherited from PreferencePropertyBase.)
Back to Top
Properties

  NameDescription
Public propertyName
Gets the name of this property.
(Inherited from PreferencePropertyBase.)
Public propertyUsage
Gets the usage of the property.
(Inherited from PreferencePropertyBase.)
Public propertyValue
Gets or sets the value of the property. A get request to this property will return the overridden value of a preference property. That is, if the user has overridden the value inherited from the user group, that inherited value is returned. Otherwise, the group value is returned. The same way, group values may override the values inherited from parent groups. If no value can be found, neither at the group level nor at the user level, a default value is returned. The default value is passed to the constructors of this class, either as a value or a PreferenceProperty T  DefaultValueCalculatorCallback. If no default value exists, null is returned for reference types, and 0 is returned for value types.

Setting the property will only affect the user level value and override the inherited group value (if such exists).

After setting or resetting the value of a preference property, Save() must be called on the owning preference to cause the property to be persisted.

Public propertyValueType
Gets the type of the value of this property.
(Inherited from PreferencePropertyBase.)
Back to Top
See Also