Class TimeSpanFormatter

Formatter for Spotfire.Dxp.Data.DataType.TimeSpan values.

Since

2.0

Hierarchy (View Summary)

DataFormatterBase
- TimeSpanFormatter

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: T2, type: TypeRef<T1>): 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 DataFormatterBase.Cast

Equals

Equals(obj: any): 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 DataFormatterBase.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from DataFormatterBase.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from DataFormatterBase.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): 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 DataFormatterBase.TryCast

`Static`Equals

Equals(objA: any, objB: any): 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 DataFormatterBase.Equals

Default capability

CultureName

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

Returns null | string
Remark
If a specific culture is set, this will always be used, regardless of locale. Assigning this property to null (which is the default) means that the formatter will always be localized. Assigning this property to string.Empty means invariant formatting.

Since
2.0

Inherited from DataFormatterBase.CultureName
set CultureName(value: null | string): void
Parameters
- value: null | string
Returns void
Inherited from DataFormatterBase.CultureName

EmptyString

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

Returns null | string
Since
2.0

Inherited from DataFormatterBase.EmptyString
set EmptyString(value: null | string): void
Parameters
- value: null | string
Returns void
Inherited from DataFormatterBase.EmptyString

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

Inherited from DataFormatterBase.ExactParse
set ExactParse(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from DataFormatterBase.ExactParse

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

Inherited from DataFormatterBase.IsLocalized

IsReadOnly

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

Returns boolean
Since
2.0

Inherited from DataFormatterBase.IsReadOnly

Clone

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

Returns unknown
A new formatter copied from the original formatter

Remark
The clone is writable even if the original formatter is read-only

Since
2.0

Inherited from DataFormatterBase.Clone

Format

Format(obj: any): 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
Inherited from DataFormatterBase.Format

FormatInvalid

FormatInvalid(error: string | String): 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
Inherited from DataFormatterBase.FormatInvalid

Parse

Parse(str: string | String): 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
Inherited from DataFormatterBase.Parse

TryParse

TryParse(str: string | String, result: OutParam<System.Object>): 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
Inherited from DataFormatterBase.TryParse

`Static`AsReadOnly

AsReadOnly(formatter: DataFormatterBase): 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

Inherited from DataFormatterBase.AsReadOnly

Class TimeSpanFormatter

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

CultureName

Returns null | string

Remark

Since

Parameters

Returns void

EmptyString

Returns null | string

Since

Parameters

Returns void

ExactParse

Returns boolean

Since

Parameters

Returns void

IsLocalized

Returns boolean

Since

IsReadOnly

Returns boolean

Since

Clone

Returns unknown

Remark

Since

Format

Parameters

Returns string

Since

FormatInvalid

Parameters

Returns string

Since

Parse

Parameters

Returns unknown

Since

TryParse

Parameters

Returns boolean

Since

StaticAsReadOnly

Parameters

Returns DataFormatterBase

Since

Settings

On This Page

`Static`Equals

`Static`AsReadOnly