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

Class DataFormatterBase

Abstract base class for formatters. Handles read-only state, cloning and formatting of invalid values.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- DataFormatterBase

Implements

IDataFormatter

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

CultureName EmptyString ExactParse IsLocalized IsReadOnly Clone Format FormatInvalid Parse TryParse AsReadOnly

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
Implementation of IDataFormatter.Cast
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
Implementation of IDataFormatter.TryCast
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

CultureName

get CultureName(): string
Gets or sets the name of the culture that defines the default formatting.

Returns string
Since
2.0
set CultureName(value): void
Parameters
- value: string
Returns void

EmptyString

get EmptyString(): string
Gets or sets the string used to indicate empty values. (FormatInvalid(error)).

Returns string
Since
2.0
set EmptyString(value): void
Parameters
- value: string
Returns void

ExactParse

get ExactParse(): boolean
Gets or sets a value indicating whether the format of the string representation must match the specified format exactly or not. Default is false.

Returns boolean
Since
2.0
set ExactParse(value): void
Parameters
- value: boolean
Returns void

IsLocalized

get IsLocalized(): boolean
Gets a value indicating whether this formatter is localized and always uses CultureInfo derived from the current running thread or not.

Returns boolean
Since
2.0

IsReadOnly

get IsReadOnly(): boolean
Gets a value indicating whether the formatter is read-only or not.

Returns boolean
Since
2.0

Clone

Clone(): unknown
Returns a writable copy of this formatter.

Returns unknown
A new formatter copied from the original formatter

Since
2.0

Format

Format(obj): string
Override this method to convert an object to a string value.
Parameters
- obj: any
  An object to convert.
Returns string
A string value

Since
2.0

Implementation of IDataFormatter.Format

FormatInvalid

FormatInvalid(error): string
Formats an invalid value. If error is not null, the return value includes the "(error)" string, otherwise Spotfire.Dxp.Data.Formatters.DataFormatterBase.EmptyString is returned.
Parameters
- error: string | String
  An error string. Optional (may be null).
Returns string
A string value.

Since
2.0

Implementation of IDataFormatter.FormatInvalid

Parse

Parse(str): unknown
Override this method to convert a string value to an object.
Parameters
- str: string | String
  A string value to convert.
Returns unknown
An object.

Since
2.0

Implementation of IDataFormatter.Parse

TryParse

TryParse(str, result): boolean
Converts a string representation to an object. A return value indicates whether the conversion succeeded or failed.
Parameters
- str: string | String
  The string to convert.
- result: OutParam<System.Object>
  The object that is the result of the conversion.
Returns boolean
true if str was converted successfully; otherwise, false.

Since
2.0

Implementation of IDataFormatter.TryParse

`Static`AsReadOnly

AsReadOnly(formatter): DataFormatterBase
Returns the given formatter if already read-only, otherwise a read-only copy.
Parameters
- formatter: DataFormatterBase
  A formatter.
Returns DataFormatterBase
A read-only formatter.

Since
2.0