Action
    Preparing search index...

    Class NumberFormatter

    Abstract base class for number formatters.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Category CultureName CurrencyCultureName DecimalDigits DecimalDigitsMode EmptyString ExactParse FormatString GroupSeparatorEnabled IsLocalized IsReadOnly NegativePattern NumberStyles ShortFormattingEnabled ShortFormattingSymbolScheme UseEngineeringNotation Clone Format FormatInvalid Parse TryParse AsReadOnly

    Methods

    • 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.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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.

    Default capability

    • get CultureName(): null | string

      Gets or sets the name of the culture that defines the default formatting.

      Returns null | string

      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.

      2.0

    • set CultureName(value: null | string): void

      Parameters

      • value: null | string

      Returns void

    • get CurrencyCultureName(): string

      Gets or sets the name of the culture that defines the currency formatting.

      Returns string

      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.

      2.0

    • set CurrencyCultureName(value: string): void

      Parameters

      • value: string

      Returns void

    • get DecimalDigits(): number

      Gets or sets the number of decimal digits. If not explicitly set, a default value is returned according to the current Spotfire.Dxp.Data.Formatters.NumberFormatter.Category: General: -1 (not applicable)Number: CultureInfo.NumberFormat.NumberDecimalDigitsCurrency: CultureInfo.NumberFormat.CurrencyDecimalDigitsPercentage: CultureInfo.NumberFormat.PercentDecimalDigitsScientific: 6 Custom: -1 (not applicable)

      Returns number

      This property does not have any effect on the General and Custom categories.

      2.0

    • set DecimalDigits(value: number): void

      Parameters

      • value: number

      Returns void

    • get EmptyString(): null | string

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

      Returns null | string

      2.0

    • set EmptyString(value: null | string): void

      Parameters

      • value: null | string

      Returns void

    • 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

      2.0

    • set ExactParse(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get FormatString(): string

      Gets or sets a format string that defines how values are formatted.

      Returns string

      The FormatString is automatically updated whenever a property is changed. Setting the FormatString explicitly will change the Spotfire.Dxp.Data.Formatters.NumberFormatter.Category to Custom.

      2.0

    • set FormatString(value: string): void

      Parameters

      • value: string

      Returns void

    • get GroupSeparatorEnabled(): boolean

      Gets or sets a value indicating whether the group separator is enabled or not.

      Returns boolean

      This property does not have any effect on the General, Scientific and Custom categories.

      2.0

    • set GroupSeparatorEnabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • 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

      2.0

    • get IsReadOnly(): boolean

      Gets a value indicating whether the formatter is read-only or not.

      Returns boolean

      2.0

    • get ShortFormattingEnabled(): boolean

      Gets or sets a value indicating whether or not short number formatting should be used.

      Returns boolean

      This property only applies to categories Currency and Number.

      2.0

    • set ShortFormattingEnabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • Returns a writable copy of this formatter.

      Returns unknown

      A new formatter copied from the original formatter

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

      2.0

    • Override this method to convert an object to a string value.

      Parameters

      • obj: any

        An object to convert.

      Returns string

      A string value

      2.0

    • Override this method to convert a string value to an object.

      Parameters

      • str: string | String

        A string value to convert.

      Returns unknown

      An object.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability