NumberFormat Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
<strong>[icu enhancement]</strong> ICU's replacement for java.text.NumberFormat.
[Android.Runtime.Register("android/icu/text/NumberFormat", ApiSince=24, DoNotGenerateAcw=true)]
public abstract class NumberFormat : Android.Icu.Text.UFormat[<Android.Runtime.Register("android/icu/text/NumberFormat", ApiSince=24, DoNotGenerateAcw=true)>]
type NumberFormat = class
inherit UFormat- Inheritance
- Derived
- Attributes
Remarks
<strong>[icu enhancement]</strong> ICU's replacement for java.text.NumberFormat. Methods, fields, and other functionality specific to ICU are labeled '<strong>[icu]</strong>'.
<strong>IMPORTANT:</strong> New users are strongly encouraged to see if NumberFormatter fits their use case. Although not deprecated, this class, NumberFormat, is only provided for java.text.NumberFormat compatibility. <hr>
NumberFormat is the abstract base class for all number formats. This class provides the interface for formatting and parsing numbers. NumberFormat also provides methods for determining which locales have number formats, and what their names are.
NumberFormat helps you to format and parse numbers for any locale. Your code can be completely independent of the locale conventions for decimal points, thousands-separators, or even the particular decimal digits used, or whether the number format is even decimal.
To format a number for the current Locale, use one of the factory class methods: <blockquote>
myString = NumberFormat.getInstance().format(myNumber);
</blockquote> If you are formatting multiple numbers, it is more efficient to get the format and use it multiple times so that the system doesn't have to fetch the information about the local language and country conventions multiple times. <blockquote>
NumberFormat nf = NumberFormat.getInstance();
for (int i = 0; i < a.length; ++i) {
output.println(nf.format(myNumber[i]) + "; ");
}
</blockquote> To format a number for a different Locale, specify it in the call to getInstance. <blockquote>
NumberFormat nf = NumberFormat.getInstance(Locale.FRENCH);
</blockquote> You can also use a NumberFormat to parse numbers: <blockquote>
myNumber = nf.parse(myString);
</blockquote> Use getInstance or getNumberInstance to get the normal number format. Use getIntegerInstance to get an integer number format. Use getCurrencyInstance to get the currency number format. And use getPercentInstance to get a format for displaying percentages. Some factory methods are found within subclasses of NumberFormat. With this format, a fraction like 0.53 is displayed as 53%.
Starting from ICU 4.2, you can use getInstance() by passing in a 'style' as parameter to get the correct instance. For example, use getInstance(...NUMBERSTYLE) to get the normal number format, getInstance(...PERCENTSTYLE) to get a format for displaying percentage, getInstance(...SCIENTIFICSTYLE) to get a format for displaying scientific number, getInstance(...INTEGERSTYLE) to get an integer number format, getInstance(...CURRENCYSTYLE) to get the currency number format, in which the currency is represented by its symbol, for example, "$3.00". getInstance(...ISOCURRENCYSTYLE) to get the currency number format, in which the currency is represented by its ISO code, for example "USD3.00". getInstance(...PLURALCURRENCYSTYLE) to get the currency number format, in which the currency is represented by its full name in plural format, for example, "3.00 US dollars" or "1.00 US dollar".
You can also control the display of numbers with such methods as setMinimumFractionDigits. If you want even more control over the format or parsing, or want to give your users more control, you can try casting the NumberFormat you get from the factory methods to a DecimalFormat. This will work for the vast majority of locales; just remember to put it in a try block in case you encounter an unusual one.
NumberFormat is designed such that some controls work for formatting and others work for parsing. The following is the detailed description for each these control methods,
setParseIntegerOnly : only affects parsing, e.g. if true, "3456.78" -> 3456 (and leaves the parse position just after '6') if false, "3456.78" -> 3456.78 (and leaves the parse position just after '8') This is independent of formatting. If you want to not show a decimal point where there might be no digits after the decimal point, use setDecimalSeparatorAlwaysShown on DecimalFormat.
You can also use forms of the parse and format methods with ParsePosition and FieldPosition to allow you to: <ul> <li> progressively parse through pieces of a string <li> align the decimal point and other areas </ul> For example, you can align numbers in two ways: <ol> <li> If you are using a monospaced font with spacing for alignment, you can pass the FieldPosition in your format call, with field = INTEGER_FIELD. On output, getEndIndex will be set to the offset between the last character of the integer and the decimal. Add (desiredSpaceCount - getEndIndex) spaces at the front of the string.
<li> If you are using proportional fonts, instead of padding with spaces, measure the width of the string in pixels from the start to getEndIndex. Then move the pen by (desiredPixelWidth - widthToAlignmentPoint) before drawing the text. It also works where there is no decimal, but possibly additional characters at the end, e.g., with parentheses in negative numbers: "(12)" for -12. </ol>
<h3>Synchronization</h3>
Number formats are generally not synchronized. It is recommended to create separate format instances for each thread. If multiple threads access a format concurrently, it must be synchronized externally.
<h4>DecimalFormat</h4>
DecimalFormat is the concrete implementation of NumberFormat, and the NumberFormat API is essentially an abstraction from DecimalFormat's API. Refer to DecimalFormat for more information about this API.
see DecimalFormat see java.text.ChoiceFormat
Java documentation for android.icu.text.NumberFormat.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.
Constructors
| NumberFormat() |
Empty constructor. |
| NumberFormat(IntPtr, JniHandleOwnership) | |
Fields
| Accountingcurrencystyle |
Obsolete.
<strong>[icu]</strong> Constant to specify currency style of format which uses currency symbol to represent currency for accounting, for example: "($3. |
| Cashcurrencystyle |
Obsolete.
<strong>[icu]</strong> Constant to specify currency cash style of format which uses currency ISO code to represent currency, for example: "NT$3" instead of "NT$3. |
| Currencystyle |
Obsolete.
<strong>[icu]</strong> Constant to specify general currency style of format. |
| FractionField |
Obsolete.
Field constant used to construct a FieldPosition object. |
| IntegerField |
Obsolete.
Field constant used to construct a FieldPosition object. |
| Integerstyle |
Obsolete.
<strong>[icu]</strong> Constant to specify a integer number style format. |
| Isocurrencystyle |
Obsolete.
<strong>[icu]</strong> Constant to specify currency style of format which uses currency ISO code to represent currency, for example: "USD3. |
| Numberstyle |
Obsolete.
<strong>[icu]</strong> Constant to specify normal number style of format. |
| Percentstyle |
Obsolete.
<strong>[icu]</strong> Constant to specify a style of format to display percent. |
| Pluralcurrencystyle |
Obsolete.
<strong>[icu]</strong> Constant to specify currency style of format which uses currency long name with plural format to represent currency, for example, "3. |
| Scientificstyle |
Obsolete.
<strong>[icu]</strong> Constant to specify a style of format to display scientific number. |
| Standardcurrencystyle |
Obsolete.
<strong>[icu]</strong> Constant to specify currency style of format which uses currency symbol to represent currency, for example "$3. |
Properties
| Class |
Returns the runtime class of this |
| Currency |
Returns the |
| CurrencyInstance |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GroupingUsed |
Returns true if grouping is used in this format. -or- Sets whether or not grouping will be used in this format. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| Instance |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| IntegerInstance |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| JniIdentityHashCode | (Inherited from Object) |
| JniPeerMembers | |
| MaximumFractionDigits |
Returns the maximum number of digits allowed in the fraction portion of a number. -or- Sets the maximum number of digits allowed in the fraction portion of a number. |
| MaximumIntegerDigits |
Returns the maximum number of digits allowed in the integer portion of a number. -or- Sets the maximum number of digits allowed in the integer portion of a number. |
| MinimumFractionDigits |
Returns the minimum number of digits allowed in the fraction portion of a number. -or- Sets the minimum number of digits allowed in the fraction portion of a number. |
| MinimumIntegerDigits |
Returns the minimum number of digits allowed in the integer portion of a number. -or- Sets the minimum number of digits allowed in the integer portion of a number. |
| NumberInstance |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| ParseIntegerOnly |
Returns true if this format will parse numbers as integers only. -or- Sets whether to ignore the fraction part of a number when parsing (defaults to false). |
| ParseStrict |
<strong>[icu]</strong> Returns whether strict parsing is in effect. -or- <strong>[icu]</strong> Sets whether strict parsing is in effect. |
| PeerReference | (Inherited from Object) |
| PercentInstance |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| RoundingMode |
Returns the rounding mode used in this NumberFormat. -or- Set the rounding mode used in this NumberFormat. |
| ScientificInstance |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| ThresholdClass | |
| ThresholdType | |
Methods
| Clone() |
Creates and returns a copy of this object. (Inherited from _Format) |
| Dispose() | (Inherited from Object) |
| Dispose(Boolean) | (Inherited from Object) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| Format(BigDecimal, StringBuffer, FieldPosition) |
<strong>[icu]</strong> Formats an ICU BigDecimal. |
| Format(BigDecimal, StringBuffer, FieldPosition) |
<strong>[icu]</strong> Formats a BigDecimal. |
| Format(BigDecimal) |
Convenience method to format a BigDecimal. |
| Format(BigDecimal) |
<strong>[icu]</strong> Convenience method to format an ICU BigDecimal. |
| Format(BigInteger, StringBuffer, FieldPosition) |
<strong>[icu]</strong> Formats a BigInteger. |
| Format(BigInteger) |
<strong>[icu]</strong> Convenience method to format a BigInteger. |
| Format(CurrencyAmount, StringBuffer, FieldPosition) |
<strong>[icu]</strong> Formats a CurrencyAmount. |
| Format(CurrencyAmount) |
<strong>[icu]</strong> Convenience method to format a CurrencyAmount. |
| Format(Double, StringBuffer, FieldPosition) |
Specialization of format. |
| Format(Double) |
Specialization of format. |
| Format(Int64, StringBuffer, FieldPosition) |
Specialization of format. |
| Format(Int64) |
Specialization of format. |
| Format(Object, StringBuffer, FieldPosition) |
Formats a number and appends the resulting text to the given string buffer. |
| Format(Object) |
Formats an object to produce a string. (Inherited from _Format) |
| FormatToCharacterIterator(Object) |
Formats an Object producing an |
| GetAvailableLocales() |
Returns the list of Locales for which NumberFormats are available. |
| GetContext(DisplayContext+Type) | |
| GetCurrencyInstance(Locale) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetCurrencyInstance(ULocale) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| GetInstance(Locale, NumberFormatStyles) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetInstance(Locale) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetInstance(NumberFormatStyles) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetInstance(ULocale, NumberFormatStyles) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetInstance(ULocale) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetIntegerInstance(Locale) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetIntegerInstance(ULocale) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetNumberInstance(Locale) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetNumberInstance(ULocale) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetPattern(ULocale, Int32) |
Returns the pattern for the provided locale and choice. |
| GetPercentInstance(Locale) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetPercentInstance(ULocale) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetScientificInstance(Locale) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| GetScientificInstance(ULocale) |
<strong>NOTE:</strong> New users are strongly encouraged to use
|
| JavaFinalize() |
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Notify() |
Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object) |
| NotifyAll() |
Wakes up all threads that are waiting on this object's monitor. (Inherited from Object) |
| Parse(String, ParsePosition) |
Returns a Long if possible (e. |
| Parse(String) |
Parses text from the beginning of the given string to produce a number. |
| ParseCurrency(ICharSequence, ParsePosition) |
Parses text from the given string as a CurrencyAmount. |
| ParseCurrency(String, ParsePosition) |
Parses text from the given string as a CurrencyAmount. |
| ParseObject(String, ParsePosition) |
Parses text from a string to produce a number. |
| ParseObject(String) |
Parses text from the beginning of the given string to produce an object. (Inherited from _Format) |
| SetContext(DisplayContext) |
<strong>[icu]</strong> Set a particular DisplayContext value in the formatter, such as CAPITALIZATION_FOR_STANDALONE. |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| ToArray<T>() | (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() | (Inherited from Object) |
| Wait() |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object) |
| Wait(Int64, Int32) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
| Wait(Int64) |
Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object) |
Explicit Interface Implementations
| IJavaPeerable.Disposed() | (Inherited from Object) |
| IJavaPeerable.DisposeUnlessReferenced() | (Inherited from Object) |
| IJavaPeerable.Finalized() | (Inherited from Object) |
| IJavaPeerable.JniManagedPeerState | (Inherited from Object) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from Object) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from Object) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from Object) |
Extension Methods
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |