DecimalFormatter DecimalFormatter DecimalFormatter DecimalFormatter Class

Formats and parses decimal numbers.

Syntax

Declaration

public sealed class DecimalFormatterpublic sealed class DecimalFormatterPublic NotInheritable Class DecimalFormatterpublic sealed class DecimalFormatter

Remarks

If your app passes language tags used in this class to any National Language Support functions, it must first convert the tags by calling ResolveLocaleName.

Constructors summary

Creates a DecimalFormatter object and initializes it to default values.

Creates a DecimalFormatter object initialized by a language list and a geographic region.

Properties summary

Gets or sets the minimum number of digits to display for the fraction part of the number.

Gets the region that is used when formatting and parsing decimal numbers.

Gets or sets the minimum number of digits to display for the integer part of the number.

Gets or sets whether the decimal point of the number should always be displayed.

Gets or sets whether the integer part of the number should be grouped.

Gets or sets whether -0 is formatted as "-0" or "0".

Gets the priority list of language identifiers that is used when formatting and parsing decimal numbers.

Gets or sets the current rounding strategy to be used when formatting numbers.

Gets or sets the numbering system that is used to format and parse decimal numbers.

Gets the geographic region that was most recently used to format or parse decimal values.

Gets the language that was most recently used to format or parse decimal values.

Gets or sets the current padding to significant digits when a decimal number is formatted.

Methods summary

Returns a string representation of a Double number.

Returns a string representation of an Int64 number.

Returns a string representation of a UInt64 number.

Returns a string representation of a Double number.

Returns a string representation of an Int64 number.

Returns a string representation of a UInt64 number.

Attempts to parse a string representation of a Double number.

Attempts to parse a string representation of an integer.

Attempts to parse a string representation of an unsigned integer.

Constructors

  • DecimalFormatter()
    DecimalFormatter()
    DecimalFormatter()
    DecimalFormatter()

    Creates a DecimalFormatter object and initializes it to default values.

    public DecimalFormatter()public New()Public Sub New()public DecimalFormatter()
  • DecimalFormatter(IIterable<String>, String)
    DecimalFormatter(IIterable<String>, String)
    DecimalFormatter(IIterable<String>, String)
    DecimalFormatter(IIterable<String>, String)

    Creates a DecimalFormatter object initialized by a language list and a geographic region.

    public DecimalFormatter(IIterable<String> languages, String geographicRegion)public New(IIterable<String> languages, String geographicRegion)Public Sub New(languages As IIterable<String>, geographicRegion As String)public DecimalFormatter(IIterable<String> languages, String geographicRegion)

    Parameters

    • languages

      The list of language identifiers, in priority order, representing the choice of languages. See Remarks.

    • geographicRegion
      System.String
      System.String
      System.String
      System.String

      The identifier for the geographic region.

    Remarks

    If your app passes language tags used in this class to any National Language Support functions, it must first convert the tags by calling ResolveLocaleName.

    Starting in : Language tags support the Unicode extensions "ca-" and "nu-". (See Unicode Key/Type Definitions.) Note that the "nu-" extension can affect the numeral system used by DecimalFormatter objects.

Properties

  • FractionDigits
    FractionDigits
    FractionDigits
    FractionDigits

    Gets or sets the minimum number of digits to display for the fraction part of the number.

    public int FractionDigits { get; set; }public int FractionDigits { get; set; }Public ReadWrite Property FractionDigits As intpublic int FractionDigits { get; set; }

    Property Value

    • int
      int
      int
      int

      The minimum number of digits to display.

  • GeographicRegion
    GeographicRegion
    GeographicRegion
    GeographicRegion

    Gets the region that is used when formatting and parsing decimal numbers.

    public string GeographicRegion { get; }public string GeographicRegion { get; }Public ReadOnly Property GeographicRegion As stringpublic string GeographicRegion { get; }

    Property Value

    • string
      string
      string
      string

      The region that is used.

  • IntegerDigits
    IntegerDigits
    IntegerDigits
    IntegerDigits

    Gets or sets the minimum number of digits to display for the integer part of the number.

    public int IntegerDigits { get; set; }public int IntegerDigits { get; set; }Public ReadWrite Property IntegerDigits As intpublic int IntegerDigits { get; set; }

    Property Value

    • int
      int
      int
      int

      The minimum number of digits to display.

  • IsDecimalPointAlwaysDisplayed
    IsDecimalPointAlwaysDisplayed
    IsDecimalPointAlwaysDisplayed
    IsDecimalPointAlwaysDisplayed

    Gets or sets whether the decimal point of the number should always be displayed.

    public bool IsDecimalPointAlwaysDisplayed { get; set; }public bool IsDecimalPointAlwaysDisplayed { get; set; }Public ReadWrite Property IsDecimalPointAlwaysDisplayed As boolpublic bool IsDecimalPointAlwaysDisplayed { get; set; }

    Property Value

    • bool
      bool
      bool
      bool

      True if the decimal point of the number should always be displayed, and false otherwise.

  • IsGrouped
    IsGrouped
    IsGrouped
    IsGrouped

    Gets or sets whether the integer part of the number should be grouped.

    public bool IsGrouped { get; set; }public bool IsGrouped { get; set; }Public ReadWrite Property IsGrouped As boolpublic bool IsGrouped { get; set; }

    Property Value

    • bool
      bool
      bool
      bool

      True if the integer part of the number should be grouped, and false otherwise.

  • IsZeroSigned
    IsZeroSigned
    IsZeroSigned
    IsZeroSigned

    Gets or sets whether -0 is formatted as "-0" or "0".

    public bool IsZeroSigned { get; set; }public bool IsZeroSigned { get; set; }Public ReadWrite Property IsZeroSigned As boolpublic bool IsZeroSigned { get; set; }

    Property Value

    • bool
      bool
      bool
      bool

      True if -0 is formatted as "-0", and false if -0 is formatted as "0".

    Remarks

    You can set this property to specify that DecimalFormatter display negative 0 as "-0". This enables the scenario where you wish to display "-0" when it represents the rounded value of some small negative value (such as -0.00001).

    This property defaults to false to be consistent with Windows 8 and Windows Server 2012, in which -0 was always formatted as "0".

  • Languages
    Languages
    Languages
    Languages

    Gets the priority list of language identifiers that is used when formatting and parsing decimal numbers.

    public IVectorView<string> Languages { get; }public IVectorView<string> Languages { get; }Public ReadOnly Property Languages As IVectorView<string>public IVectorView<string> Languages { get; }

    Property Value

    • The priority list of language identifiers.

      Starting in : Language tags can support Unicode extensions. See the Remarks for the @Windows.Globalization.NumberFormatting.DecimalFormatter.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.String) constructor.

    Remarks

    If your app passes language tags from this class to any National Language Support functions, it must first convert the tags by calling ResolveLocaleName.

  • NumberRounder
    NumberRounder
    NumberRounder
    NumberRounder

    Gets or sets the current rounding strategy to be used when formatting numbers.

    public INumberRounder NumberRounder { get; set; }public INumberRounder NumberRounder { get; set; }Public ReadWrite Property NumberRounder As INumberRounderpublic INumberRounder NumberRounder { get; set; }

    Property Value

    Remarks

    When a Format method is called, the appropriate rounding function from the number rounder object manipulates the input prior to it being formatted.

  • NumeralSystem
    NumeralSystem
    NumeralSystem
    NumeralSystem

    Gets or sets the numbering system that is used to format and parse decimal numbers.

    public string NumeralSystem { get; set; }public string NumeralSystem { get; set; }Public ReadWrite Property NumeralSystem As stringpublic string NumeralSystem { get; set; }

    Property Value

    • string
      string
      string
      string

      A string that indicates the numeral system of the formatter, such as "Latn" for the Latin numeral system (0123456789) or "Arab" for the Arabic-Indic numeral system (٠١٢٣٤٥٦٧٨٩). See the supported NumeralSystem values.

  • ResolvedGeographicRegion
    ResolvedGeographicRegion
    ResolvedGeographicRegion
    ResolvedGeographicRegion

    Gets the geographic region that was most recently used to format or parse decimal values.

    public string ResolvedGeographicRegion { get; }public string ResolvedGeographicRegion { get; }Public ReadOnly Property ResolvedGeographicRegion As stringpublic string ResolvedGeographicRegion { get; }

    Property Value

    • string
      string
      string
      string

      The geographic region that was most recently used to format or parse decimal values.

  • ResolvedLanguage
    ResolvedLanguage
    ResolvedLanguage
    ResolvedLanguage

    Gets the language that was most recently used to format or parse decimal values.

    public string ResolvedLanguage { get; }public string ResolvedLanguage { get; }Public ReadOnly Property ResolvedLanguage As stringpublic string ResolvedLanguage { get; }

    Property Value

    • string
      string
      string
      string

      The language from the Languages that was most recently used to format or parse decimal values.

      Starting in : Language tags can support Unicode extensions. See the Remarks for the @Windows.Globalization.NumberFormatting.DecimalFormatter.#ctor(Windows.Foundation.Collections.IIterable{System.String},System.String) constructor.

    Remarks

    If your app passes language tags from this class to any National Language Support functions, it must first convert the tags by calling ResolveLocaleName.

  • SignificantDigits
    SignificantDigits
    SignificantDigits
    SignificantDigits

    Gets or sets the current padding to significant digits when a decimal number is formatted.

    public int SignificantDigits { get; set; }public int SignificantDigits { get; set; }Public ReadWrite Property SignificantDigits As intpublic int SignificantDigits { get; set; }

    Property Value

    • int
      int
      int
      int

      The number of significant digits.

    Remarks

    Trailing zeros are added to the format until the given number of significant digits is exhausted. If there are more digits, this property does not cause them to be truncated.

Methods

  • Format(Double)
    Format(Double)
    Format(Double)
    Format(Double)

    Returns a string representation of a Double number.

    public string Format(Double value)public string Format(Double value)Public Function Format(value As Double) As stringpublic string Format(Double value)

    Parameters

    • value
      System.Double
      System.Double
      System.Double
      System.Double

      The Double value to be formatted.

    Returns

    • string
      string
      string
      string

      A string that represents the number.

  • Format(Int64)
    Format(Int64)
    Format(Int64)
    Format(Int64)

    Returns a string representation of an Int64 number.

    public string Format(Int64 value)public string Format(Int64 value)Public Function Format(value As Int64) As stringpublic string Format(Int64 value)

    Parameters

    • value
      System.Int64
      System.Int64
      System.Int64
      System.Int64

      The Int64 value to be formatted.

    Returns

    • string
      string
      string
      string

      A string that represents the number.

  • Format(UInt64)
    Format(UInt64)
    Format(UInt64)
    Format(UInt64)

    Returns a string representation of a UInt64 number.

    public string Format(UInt64 value)public string Format(UInt64 value)Public Function Format(value As UInt64) As stringpublic string Format(UInt64 value)

    Parameters

    • value
      System.UInt64
      System.UInt64
      System.UInt64
      System.UInt64

      The UInt64 value to be formatted.

    Returns

    • string
      string
      string
      string

      A string that represents the number.

  • FormatDouble(Double)
    FormatDouble(Double)
    FormatDouble(Double)
    FormatDouble(Double)

    Returns a string representation of a Double number.

    public string FormatDouble(Double value)public string FormatDouble(Double value)Public Function FormatDouble(value As Double) As stringpublic string FormatDouble(Double value)

    Parameters

    • value
      System.Double
      System.Double
      System.Double
      System.Double

      The Double value to be formatted.

    Returns

    • string
      string
      string
      string

      A string that represents the number.

  • FormatInt(Int64)
    FormatInt(Int64)
    FormatInt(Int64)
    FormatInt(Int64)

    Returns a string representation of an Int64 number.

    public string FormatInt(Int64 value)public string FormatInt(Int64 value)Public Function FormatInt(value As Int64) As stringpublic string FormatInt(Int64 value)

    Parameters

    • value
      System.Int64
      System.Int64
      System.Int64
      System.Int64

      The Int64 value to be formatted.

    Returns

    • string
      string
      string
      string

      A string that represents the number.

  • FormatUInt(UInt64)
    FormatUInt(UInt64)
    FormatUInt(UInt64)
    FormatUInt(UInt64)

    Returns a string representation of a UInt64 number.

    public string FormatUInt(UInt64 value)public string FormatUInt(UInt64 value)Public Function FormatUInt(value As UInt64) As stringpublic string FormatUInt(UInt64 value)

    Parameters

    • value
      System.UInt64
      System.UInt64
      System.UInt64
      System.UInt64

      The UInt64 value to be formatted.

    Returns

    • string
      string
      string
      string

      A string that represents the number.

  • ParseDouble(String)
    ParseDouble(String)
    ParseDouble(String)
    ParseDouble(String)

    Attempts to parse a string representation of a Double number.

    public IReference<double> ParseDouble(String text)public IReference<double> ParseDouble(String text)Public Function ParseDouble(text As String) As IReference( Of double )public IReference<double> ParseDouble(String text)

    Parameters

    • text
      System.String
      System.String
      System.String
      System.String

      The text to be parsed.

    Returns

    • If successful, a Double that corresponds to the string representation, and otherwise null.

  • ParseInt(String)
    ParseInt(String)
    ParseInt(String)
    ParseInt(String)

    Attempts to parse a string representation of an integer.

    public IReference<long> ParseInt(String text)public IReference<long> ParseInt(String text)Public Function ParseInt(text As String) As IReference( Of long )public IReference<long> ParseInt(String text)

    Parameters

    • text
      System.String
      System.String
      System.String
      System.String

      The text to be parsed.

    Returns

    • If successful, an Int64 that corresponds to the string representation, and otherwise null.

  • ParseUInt(String)
    ParseUInt(String)
    ParseUInt(String)
    ParseUInt(String)

    Attempts to parse a string representation of an unsigned integer.

    public IReference<ulong> ParseUInt(String text)public IReference<ulong> ParseUInt(String text)Public Function ParseUInt(text As String) As IReference( Of ulong )public IReference<ulong> ParseUInt(String text)

    Parameters

    • text
      System.String
      System.String
      System.String
      System.String

      The text to be parsed.

    Returns

    • If successful, a UInt64 that corresponds to the string representation, and otherwise null.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ActivatableAttribute
Windows.Foundation.Metadata.ActivatableAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.ThreadingAttribute

Details

Assembly

Windows.Globalization.NumberFormatting.dll