NumberFormatter Class

Spotfire 14.2 API Reference
Abstract base class for number formatters.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Data.FormattersDataFormatterBase
    Spotfire.Dxp.Data.FormattersNumberFormatter

Namespace:  Spotfire.Dxp.Data.Formatters
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(63, 0)]
public abstract class NumberFormatter : DataFormatterBase

The NumberFormatter type exposes the following members.

Constructors

  NameDescription
Protected methodNumberFormatter
Initializes a new instance of the NumberFormatter class.
Top
Properties

  NameDescription
Public propertyCategory
Gets or sets the NumberFormatCategory.
Public propertyCultureInfo
Gets or sets a CultureInfo object that defines the default formatting.
(Overrides DataFormatterBaseCultureInfo.)
Public propertyCultureName
Gets or sets the name of the culture that defines the default formatting.
(Inherited from DataFormatterBase.)
Public propertyCurrencyCulture
Gets or sets a culture that defines the currency formatting. The following properties are used: CurrencySymbol and CurrencyPositivePattern.
Public propertyCurrencyCultureName
Gets or sets the name of the culture that defines the currency formatting.
Public propertyDecimalDigits
Gets or sets the number of decimal digits. If not explicitly set, a default value is returned according to the current Category: General: -1 (not applicable)Number: CultureInfo.NumberFormat.NumberDecimalDigitsCurrency: CultureInfo.NumberFormat.CurrencyDecimalDigitsPercentage: CultureInfo.NumberFormat.PercentDecimalDigitsScientific: 6 Custom: -1 (not applicable)
Public propertyDecimalDigitsMode
Gets or sets a value indicating how decimal digits should be handled. DecimalDigitsMode.
Public propertyEmptyString
Gets or sets the string used to indicate empty values. (FormatInvalid(String)).
(Inherited from DataFormatterBase.)
Public propertyExactParse
Gets or sets a value indicating whether the format of the string representation must match the specified format exactly or not. Default is false.
(Inherited from DataFormatterBase.)
Protected propertyFormatInfo
Gets the number formatting according to the current configuration of the DecimalDigits, GroupSeparatorEnabled, NegativePattern and CurrencyCulture properties.
Public propertyFormatString
Gets or sets a format string that defines how values are formatted.
Public propertyGroupSeparatorEnabled
Gets or sets a value indicating whether the group separator is enabled or not.
Public propertyIsLocalized
Gets a value indicating whether this formatter is localized and always uses CultureInfo derived from the current running thread or not.
(Inherited from DataFormatterBase.)
Public propertyIsReadOnly
Gets a value indicating whether the formatter is read-only or not.
(Inherited from DataFormatterBase.)
Public propertyNegativePattern
Gets or sets the NumberFormatNegativePattern.
Public propertyNumberStyles
Gets or sets a NumberStyles object that defines how string representations are parsed.
Public propertyShortFormattingEnabled
Gets or sets a value indicating whether or not short number formatting should be used.
Public propertyShortFormattingSymbolScheme
Gets or sets the symbol scheme to use for short number formatting.
Public propertyUseEngineeringNotation
Gets or sets a value indicating whether or not engineering notation should be used, which rounds the exponent in scientific formatting to a multiple of 3. The default value is false.
Top
Methods

  NameDescription
Protected methodCheckReadOnly
Throws InvalidOperationException if the formatter is read-only. Do this check before setting a property.
(Inherited from DataFormatterBase.)
Public methodClone
Returns a writable copy of this formatter.
(Inherited from DataFormatterBase.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Overrides DataFormatterBaseEquals(Object).)
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 methodFormat
Override this method to convert an object to a string value.
(Inherited from DataFormatterBase.)
Public methodFormatInvalid
Formats an invalid value. If error is not null, the return value includes the "(error)" string, otherwise EmptyString is returned.
(Inherited from DataFormatterBase.)
Public methodGetHashCode
Gets a hash code for the current Object.
(Overrides DataFormatterBaseGetHashCode.)
Public methodGetObjectData
Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides DataFormatterBaseGetObjectData(SerializationInfo, StreamingContext).)
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 methodParse
Override this method to convert a string value to an object.
(Inherited from DataFormatterBase.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryParse
Converts a string representation to an object. A return value indicates whether the conversion succeeded or failed.
(Inherited from DataFormatterBase.)
Top
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference