About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class PreferencePropertyBase

Base class for a preference property. For more information, refer to Spotfire.Dxp.Framework.Preferences.PreferenceProperty.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- PreferencePropertyBase
  - PreferenceProperty

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Name Usage ValueType Reset UndoChanges

Methods

Cast

Cast<T1, T2>(this, type): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Equals

Equals(obj): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this, type): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

Equals(objA, objB): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from Object.Equals

Default capability

Name

get Name(): string
Gets the name of this property.

Returns string
Since
2.0

Usage

get Usage(): PreferenceUsage
Gets the usage of the property.

Returns PreferenceUsage
Since
2.0

ValueType

get ValueType(): Type
Gets the type of the value of this property.

Returns Type
Since
2.0

Reset

Reset(): void
Resets any value that may explicitly have been given to this property on a user level basis through a call to Spotfire.Dxp.Framework.Preferences.PreferenceProperty.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.

Returns void
Since
2.0

UndoChanges

UndoChanges(): void
Undoes any changes that may have been to the value of this property since it was last saved.

Returns void
Since
2.0