Movatterモバイル変換

Pad position.

Stable:

ICU 2.4

Definition at line672 of filedecimfmt.h.

Create aDecimalFormat using the default pattern and symbols for the default locale.

This is a convenient way to obtain aDecimalFormat when internationalization is not the main concern.

To obtain standard formats for a given locale, use the factory methods onNumberFormat such as createInstance. These factories will return the most appropriate sub-class ofNumberFormat for a given locale.

NOTE: New users are strongly encouraged to useicu::number::NumberFormatter instead ofDecimalFormat.

Parameters

status

Output param set to success/failure code. If the pattern is invalid this will be set to a failure code.

Stable:

ICU 2.0

Create aDecimalFormat from the given pattern and the symbols for the default locale.

This is a convenient way to obtain aDecimalFormat when internationalization is not the main concern.

To obtain standard formats for a given locale, use the factory methods onNumberFormat such as createInstance. These factories will return the most appropriate sub-class ofNumberFormat for a given locale.

NOTE: New users are strongly encouraged to useicu::number::NumberFormatter instead ofDecimalFormat.

Parameters

pattern	A non-localized pattern string.
status	Output param set to success/failure code. If the pattern is invalid this will be set to a failure code.

Stable:

ICU 2.0

Create aDecimalFormat from the given pattern and symbols.

Use this constructor when you need to completely customize the behavior of the format.

To obtain standard formats for a given locale, use the factory methods onNumberFormat such as createInstance or createCurrencyInstance. If you need only minor adjustments to a standard format, you can modify the format returned by aNumberFormat factory method.

NOTE: New users are strongly encouraged to useicu::number::NumberFormatter instead ofDecimalFormat.

Parameters

pattern	a non-localized pattern string
symbolsToAdopt	the set of symbols to be used. The caller should not delete this object after making this call.
status	Output param set to success/failure code. If the pattern is invalid this will be set to a failure code.

Stable:

ICU 2.0

This API is for ICU use only.

Create aDecimalFormat from the given pattern, symbols, and style.

Parameters

pattern	a non-localized pattern string
symbolsToAdopt	the set of symbols to be used. The caller should not delete this object after making this call.
style	style of decimal format
status	Output param set to success/failure code. If the pattern is invalid this will be set to a failure code.

Internal:

Do not use. This API is for internal use only.

Create aDecimalFormat from the given pattern and symbols.

Use this constructor when you need to completely customize the behavior of the format.

To obtain standard formats for a given locale, use the factory methods onNumberFormat such as createInstance or createCurrencyInstance. If you need only minor adjustments to a standard format, you can modify the format returned by aNumberFormat factory method.

NOTE: New users are strongly encouraged to useicu::number::NumberFormatter instead ofDecimalFormat.

Parameters

pattern	a non-localized pattern string
symbolsToAdopt	the set of symbols to be used. The caller should not delete this object after making this call.
parseError	Output param to receive errors occurred during parsing
status	Output param set to success/failure code. If the pattern is invalid this will be set to a failure code.

Stable:

ICU 2.0

Create aDecimalFormat from the given pattern and symbols.

Use this constructor when you need to completely customize the behavior of the format.

To obtain standard formats for a given locale, use the factory methods onNumberFormat such as createInstance or createCurrencyInstance. If you need only minor adjustments to a standard format, you can modify the format returned by aNumberFormat factory method.

NOTE: New users are strongly encouraged to useicu::number::NumberFormatter instead ofDecimalFormat.

Parameters

pattern	a non-localized pattern string
symbols	the set of symbols to be used
status	Output param set to success/failure code. If the pattern is invalid this will be set to a failure code.

Stable:

ICU 2.0

Copy constructor.

Parameters

source

theDecimalFormat object to be copied from.

Stable:

ICU 2.0

Destructor.

Stable:

ICU 2.0

Sets the currency plural format information, which is generally not changed by the programmer or user.

Parameters

toAdopt

CurrencyPluralInfo to be adopted.

Stable:

ICU 4.2

Sets the decimal format symbols, which is generally not changed by the programmer or user.

Parameters

symbolsToAdopt

DecimalFormatSymbols to be adopted.

Stable:

ICU 2.0

Apply the given pattern to thisFormat object.

Parameters

pattern	The localized pattern to be applied.
status	Output param set to success/failure code on exit. If the pattern is invalid, this will be set to a failure result.

Stable:

ICU 2.0

Apply the given pattern to thisFormat object.

The pattern is assumed to be in a localized notation. A pattern is a short-hand specification for the various formatting properties. These properties can also be changed individually through the various setter methods.

There is no limit to integer digits are set by this routine, since that is the typical end-user desire; use setMaximumInteger if you want to set a real value. For negative numbers, use a second pattern, separated by a semicolon

.      Example "#,#00.0#" -> 1,234.56

This means a minimum of 2 integer digits, 1 fraction digit, and a maximum of 2 fraction digits.

Example: "#,#00.0#;(#,#00.0#)" for negatives in parentheses.

In negative patterns, the minimum and maximum counts are ignored; these are presumed to be set in the positive pattern.

Parameters

pattern	The localized pattern to be applied.
parseError	Struct to receive information on position of error if an error is encountered
status	Output param set to success/failure code on exit. If the pattern is invalid, this will be set to a failure result.

Stable:

ICU 2.0

Sets the pattern.

Parameters

pattern	The pattern to be applied.
status	Output param set to success/failure code on exit. If the pattern is invalid, this will be set to a failure result.

Stable:

ICU 2.0

Apply the given pattern to thisFormat object.

A pattern is a short-hand specification for the various formatting properties. These properties can also be changed individually through the various setter methods.

There is no limit to integer digits are set by this routine, since that is the typical end-user desire; use setMaximumInteger if you want to set a real value. For negative numbers, use a second pattern, separated by a semicolon

.      Example "#,#00.0#" -> 1,234.56

This means a minimum of 2 integer digits, 1 fraction digit, and a maximum of 2 fraction digits.

.      Example: "#,#00.0#;(#,#00.0#)" for negatives in parentheses.

In negative patterns, the minimum and maximum counts are ignored; these are presumed to be set in the positive pattern.

Parameters

pattern	The pattern to be applied.
parseError	Struct to receive information on position of error if an error is encountered
status	Output param set to success/failure code on exit. If the pattern is invalid, this will be set to a failure result.

Stable:

ICU 2.0

Returns true if significant digits are in use, or false if integer and fraction digit counts are in use.

Returns

true if significant digits are in use

Stable:

ICU 3.0

Clone thisFormat object polymorphically.

The caller owns the result and should delete it when done.

Returns

a polymorphic copy of thisDecimalFormat.

Stable:

ICU 2.0

Implementsicu::NumberFormat.

Format an object to produce a string.

This method handlesFormattable objects with numeric types. If theFormattable object type is not a numeric type, then it returns a failing UErrorCode.

Parameters

obj	The object to format.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format an object to produce a string.

This method handlesFormattable objects with numeric types. If theFormattable object type is not a numeric type, then it returns a failing UErrorCode.

Parameters

obj	The object to format.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Format a decimal number.

The number is a DecimalQuantity wrapper onto a floating point decimal number. The default implementation inNumberFormat converts the decimal number to a double and formats that. Subclasses ofNumberFormat that want to specifically handle big decimal numbers must override this method. classDecimalFormat does so.

Parameters

number	The number, a DecimalQuantity format Decimal Floating Point.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Format a decimal number.

The number is a DecimalQuantity wrapper onto a floating point decimal number. The default implementation inNumberFormat converts the decimal number to a double and formats that.

Parameters

number	The number, a DecimalQuantity format Decimal Floating Point.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Reimplemented fromicu::NumberFormat.

Format a decimal number.

The number is a DecimalQuantity wrapper onto a floating point decimal number. The default implementation inNumberFormat converts the decimal number to a double and formats that. Subclasses ofNumberFormat that want to specifically handle big decimal numbers must override this method. classDecimalFormat does so.

Parameters

number	The number, a DecimalQuantity format Decimal Floating Point.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Format a decimal number.

The number is a DecimalQuantity wrapper onto a floating point decimal number. The default implementation inNumberFormat converts the decimal number to a double and formats that.

Parameters

number	The number, a DecimalQuantity format Decimal Floating Point.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Reimplemented fromicu::NumberFormat.

Format a double number.

These methods call theNumberFormat pure virtualformat() methods with the defaultFieldPosition.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format a double or long number using base-10 representation.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Implementsicu::NumberFormat.

Format a double number.

Concrete subclasses must implement these pure virtual methods.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format a double number.

By default, the parent function simply calls the base class and does not return an error status. Therefore, the status may be ignored in some subclasses.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	error status

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Format a double or long number using base-10 representation.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Reimplemented fromicu::NumberFormat.

Format a double number.

Subclasses must implement this method.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Format a double or long number using base-10 representation.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Reimplemented fromicu::NumberFormat.

Format a long number.

These methods call theNumberFormat pure virtualformat() methods with the defaultFieldPosition.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format a long number using base-10 representation.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Implementsicu::NumberFormat.

Format a long number.

Concrete subclasses must implement these pure virtual methods.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format a long number.

Concrete subclasses may override this function to provide status return.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	the output status.

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Format a long number using base-10 representation.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Reimplemented fromicu::NumberFormat.

Format an int32 number.

Subclasses must implement this method.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Format a long number using base-10 representation.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Reimplemented fromicu::NumberFormat.

Format an int64 number.

These methods call theNumberFormat pure virtualformat() methods with the defaultFieldPosition.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.8

Format an int64 number.

(Not abstract to retain compatibility with earlier releases, however subclasses should override this method as it just delegates to format(int32_t number...);

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.8

Format an int64 number using base-10 representation.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.8

Reimplemented fromicu::NumberFormat.

Format an int64 number.

(Not abstract to retain compatibility with earlier releases, however subclasses should override this method as it just delegates to format(int32_t number...);

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Format an int64 number using base-10 representation.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Internal:

Do not use. This API is for internal use only.

Reimplemented fromicu::NumberFormat.

Format an int64 number.

Subclasses must implement this method.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Format an int64 number using base-10 representation.

Parameters

number	The value to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Reimplemented fromicu::NumberFormat.

Format a decimal number.

Subclasses must implement this method. The syntax of the unformatted number is a "numeric string" as defined in the Decimal Arithmetic Specification, available athttp://speleotrove.com/decimal

Parameters

number	The unformatted number, as a string, to be formatted.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Format a decimal number.

The syntax of the unformatted number is a "numeric string" as defined in the Decimal Arithmetic Specification, available athttp://speleotrove.com/decimal

Parameters

number	The unformatted number, as a string.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call. Can be nullptr.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Reimplemented fromicu::NumberFormat.

Get a DecimalQuantity corresponding to a formattable as it would be formatted by thisDecimalFormat.

Internal, not intended for public use.

Internal:

Do not use. This API is for internal use only.

Format a number and save it into the given DecimalQuantity.

Internal, not intended for public use.

Internal:

Do not use. This API is for internal use only.

Get an integer May return U_UNSUPPORTED_ERROR if this instance does not support the specified attribute.

Parameters

attr	the attribute to set
status	the error type

Returns

the attribute value. Undefined if there is an error.

Stable:

ICU 51

Returns the currency plural format information, which is generally not changed by the programmer or user.

Returns

desiredCurrencyPluralInfo

Stable:

ICU 4.2

Returns theCurrency Usage object used to display currency.

Stable:

ICU 54

Returns the decimal format symbols, which is generally not changed by the programmer or user.

Returns

desiredDecimalFormatSymbols

See also

DecimalFormatSymbols

Stable:

ICU 2.0

Returns a unique class ID POLYMORPHICALLY.

Pure virtual override. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphicoperator==() andclone() methods call this method.

Returns

The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs.

Stable:

ICU 2.0

Implementsicu::NumberFormat.

Get the width to which the output offormat() is padded.

The width is counted in 16-bit code units.

Returns

the format width, or zero if no padding is in effect

See also

setFormatWidth

getPadCharacterString

setPadCharacter

getPadPosition

setPadPosition

Stable:

ICU 2.0

Return the grouping size.

Grouping size is the number of digits between grouping separators in the integer portion of a number. For example, in the number "123,456.78", the grouping size is 3.

Returns

the grouping size.

See also

setGroupingSize

NumberFormat::isGroupingUsed

DecimalFormatSymbols::getGroupingSeparator

Stable:

ICU 2.0

Returns the maximum number of significant digits that will be displayed.

This value has no effect unlessareSignificantDigitsUsed() returns true.

Returns

the most significant digits that will be shown

Stable:

ICU 3.0

Return the minimum exponent digits that will be shown.

Returns

the minimum exponent digits that will be shown

See also

setScientificNotation

isScientificNotation

setMinimumExponentDigits

isExponentSignAlwaysShown

setExponentSignAlwaysShown

Stable:

ICU 2.0

Returns the minimum number of grouping digits.

Grouping separators are output if there are at least this many digits to the left of the first (rightmost) grouping separator, that is, there are at least (minimum grouping + grouping size) integer digits. (Subject toisGroupingUsed().)

For example, if this value is 2, and the grouping size is 3, then 9999 -> "9999" and 10000 -> "10,000"

The default value for this attribute is 0. A value of 1, 0, or lower, means that the use of grouping separators only depends on the grouping size (and onisGroupingUsed()).

NOTE: The CLDR data is used in NumberFormatter but not inDecimalFormat. This is for backwards compatibility reasons.

For more control over grouping strategies, use NumberFormatter.

See also

setMinimumGroupingDigits

getGroupingSize

Stable:

ICU 64

Returns the minimum number of significant digits that will be displayed.

This value has no effect unlessareSignificantDigitsUsed() returns true.

Returns

the fewest significant digits that will be shown

Stable:

ICU 3.0

Get the multiplier for use in percent, permill, etc.

For a percentage, set the suffixes to have "%" and the multiplier to be 100. (For Arabic, use arabic percent symbol). For a permill, set the suffixes to have "\\u2031" and the multiplier to be 1000.

The number may also be multiplied by a power of ten; seegetMultiplierScale().

Returns

the multiplier for use in percent, permill, etc. Examples: with 100, 1.23 -> "123", and "123" -> 1.23

Stable:

ICU 2.0

Gets the power of ten by which number should be multiplied before formatting, which can be combined withsetMultiplier() to multiply by any arbitrary decimal value.

A multiplier scale of 2 corresponds to multiplication by 100, and a multiplier scale of -2 corresponds to multiplication by 0.01.

This method is analogous to UNUM_SCALE in getAttribute.

Returns

the current value of the power-of-ten multiplier.

Stable:

ICU 62

Get the negative prefix.

Parameters

result

Output param which will receive the negative prefix.

Returns

A reference to 'result'. Examples: -123, ($123) (with negative suffix), sFr-123

Stable:

ICU 2.0

Get the negative suffix.

Parameters

result

Output param which will receive the negative suffix.

Returns

A reference to 'result'. Examples: -123%, ($123) (with positive suffixes)

Stable:

ICU 2.0

Get the pad character used to pad to the format width.

The default is ' '.

Returns

a string containing the pad character. This will always have a length of one 32-bit code point.

See also

setFormatWidth

getFormatWidth

setPadCharacter

getPadPosition

setPadPosition

Stable:

ICU 2.0

Get the position at which padding will take place.

This is the location at which padding will be inserted if the result offormat() is shorter than the format width.

Returns

the pad position, one of kPadBeforePrefix, kPadAfterPrefix, kPadBeforeSuffix, or kPadAfterSuffix.

See also

setFormatWidth

getFormatWidth

setPadCharacter

getPadCharacterString

setPadPosition

EPadPosition

Stable:

ICU 2.0

Get the positive prefix.

Parameters

result

Output param which will receive the positive prefix.

Returns

A reference to 'result'. Examples: +123, $123, sFr123

Stable:

ICU 2.0

Get the positive suffix.

Parameters

result

Output param which will receive the positive suffix.

Returns

A reference to 'result'. Example: 123%

Stable:

ICU 2.0

Get the rounding increment.

Returns

A positive rounding increment, or 0.0 if a custom rounding increment is not in effect.

See also

setRoundingIncrement

getRoundingMode

setRoundingMode

Stable:

ICU 2.0

Get the rounding mode.

Returns

A rounding mode

See also

setRoundingIncrement

getRoundingIncrement

setRoundingMode

Stable:

ICU 2.0

Reimplemented fromicu::NumberFormat.

Return the secondary grouping size.

In some locales one grouping interval is used for the least significant integer digits (the primary grouping size), and another is used for all others (the secondary grouping size). A formatter supporting a secondary grouping size will return a positive integer unequal to the primary grouping size returned bygetGroupingSize(). For example, if the primary grouping size is 4, and the secondary grouping size is 2, then the number 123456789 formats as "1,23,45,6789", and the pattern appears as "#,##,###0".

Returns

the secondary grouping size, or a value less than one if there is none

See also

setSecondaryGroupingSize

NumberFormat::isGroupingUsed

DecimalFormatSymbols::getGroupingSeparator

Stable:

ICU 2.4

Return the class ID for this class.

This is useful only for comparing to a return value fromgetDynamicClassID(). For example:

.      Base* polymorphic_pointer = createPolymorphicObject();.      if (polymorphic_pointer->getDynamicClassID() ==.          Derived::getStaticClassID()) ...

Returns

The class ID for all objects of this class.

Stable:

ICU 2.0

Allows you to get the parse behavior of the pattern decimal mark.

Returns

true if input must contain a match to decimal mark in pattern

Stable:

ICU 54

Allows you to get the behavior of the decimal separator with integers.

(The decimal separator will always appear with decimals.)

Returns

true if the decimal separator always appear with decimals. Example: Decimal ON: 12345 -> 12345.; OFF: 12345 -> 12345

Stable:

ICU 2.0

Return whether the exponent sign is always shown.

Returns

true if the exponent is always prefixed with either the localized minus sign or the localized plus sign, false if only negative exponents are prefixed with the localized minus sign.

See also

setScientificNotation

isScientificNotation

setMinimumExponentDigits

getMinimumExponentDigits

setExponentSignAlwaysShown

Stable:

ICU 2.0

Returns whether truncation of high-order integer digits should result in an error.

By default, setMaximumIntegerDigits truncates high-order digits silently.

Returns

Whether an error code is set if high-order digits are truncated.

See also

setFormatFailIfMoreThanMaxDigits

Stable:

ICU 64

Returns whether parsing is sensitive to case (lowercase/uppercase).

Returns

Whether parsing is case-sensitive.

See also

setParseCaseSensitive

Stable:

ICU 64

Returns whether to ignore exponents when parsing.

Returns

Whether to ignore exponents when parsing.

See also

setParseNoExponent

Stable:

ICU 64

Return whether or not scientific notation is used.

Returns

true if this object formats and parses scientific notation

See also

setScientificNotation

getMinimumExponentDigits

setMinimumExponentDigits

isExponentSignAlwaysShown

setExponentSignAlwaysShown

Stable:

ICU 2.0

Whether to show the plus sign on positive (non-negative) numbers; for example, "+12".

For more control over sign display, use NumberFormatter.

Returns

Whether the sign is shown on positive numbers and zero.

Stable:

ICU 64

Assignment operator.

Parameters

rhs	theDecimalFormat object to be copied.

Stable:

ICU 2.0

Return true if the givenFormat objects are semantically equal.

Objects of different subclasses are considered unequal.

Parameters

other

the object to be compared with.

Returns

true if the givenFormat objects are semantically equal.

Stable:

ICU 2.0

Reimplemented fromicu::NumberFormat.

Parse the given string using this object's choices.

The method does string comparisons to try to find an optimal match. If no object can be parsed, index is unchanged, and nullptr is returned. The result is returned as the most parsimonious type ofFormattable that will accommodate all of the necessary precision. For example, if the result is exactly 12, it will be returned as a long. However, if it is 1.5, it will be returned as a double.

Parameters

text	The text to be parsed.
result	Formattable to be set to the parse result. If parse fails, return contents are undefined.
parsePosition	The position to start parsing at on input. On output, moved to after the last successfully parse character. On parse failure, does not change.

See also

Formattable

Stable:

ICU 2.0

Implementsicu::NumberFormat.

Return a long if possible (e.g.

within range LONG_MAX, LONG_MAX], and with no decimals), otherwise a double. If IntegerOnly is set, will stop at a decimal point (or equivalent; e.g. for rational numbers "1 2/3", will stop after the 1).

If no object can be parsed, index is unchanged, and nullptr is returned.

This is a pure virtual which concrete subclasses must implement.

Parameters

text	The text to be parsed.
result	Formattable to be set to the parse result. If parse fails, return contents are undefined.
parsePosition	The position to start parsing at on input. On output, moved to after the last successfully parse character. On parse failure, does not change.

Stable:

ICU 2.0

Parse a string as a numeric value, and return aFormattable numeric object.

This method parses integers only if IntegerOnly is set.

Parameters

text	The text to be parsed.
result	Formattable to be set to the parse result. If parse fails, return contents are undefined.
status	Output parameter set to a failure error code when a failure occurs. The error code when the string fails to parse is U_INVALID_FORMAT_ERROR, unless overridden by a subclass.

See also

NumberFormat::isParseIntegerOnly

Stable:

ICU 2.0

Parses text from the given string as a currency amount.

Unlike theparse() method, this method will attempt to parse a generic currency name, searching for a match of this object's locale's currency display names, or for a 3-letter ISO currency code. This method will fail if this format is not a currency format, that is, if it does not contain the currency pattern symbol (U+00A4) in its prefix or suffix.

Parameters

text	the string to parse
pos	input-output position; on input, the position within text to match; must have 0 <= pos.getIndex() < text.length(); on output, the position after the last matched character. If the parse fails, the position in unchanged upon output.

Returns

if parse succeeds, a pointer to a newly-createdCurrencyAmount object (owned by the caller) containing information about the parsed currency; if parse fails, this is nullptr.

Stable:

ICU 49

Reimplemented fromicu::NumberFormat.

Set an integer attribute on thisDecimalFormat.

May return U_UNSUPPORTED_ERROR if this instance does not support the specified attribute.

Parameters

attr	the attribute to set
newValue	new value
status	the error type

Returns

*this - for chaining (example: format.setAttribute(...).setAttribute(...) )

Stable:

ICU 51

Sets the currency used to display currency amounts.

SeesetCurrency(const char16_t*, UErrorCode&).

Deprecated:

ICU 3.0. UsesetCurrency(const char16_t*, UErrorCode&).

Sets the currency used to display currency amounts.

This takes effect immediately, if this format is a currency format. If this format is not a currency format, then the currency is used if and when this object becomes a currency format through the application of a new pattern.

Parameters

theCurrency	a 3-letter ISO code indicating new currency to use. It need not be null-terminated. May be the empty string or nullptr to indicate no currency.
ec	input-output error code

Stable:

ICU 3.0

Reimplemented fromicu::NumberFormat.

Sets the currency plural format information, which is generally not changed by the programmer or user.

Parameters

info	Currency Plural Info.

Stable:

ICU 4.2

Sets theCurrency Usage object used to display currency.

This takes effect immediately, if this format is a currency format.

Parameters

newUsage	new currency usage object to use.
ec	input-output error code

Stable:

ICU 54

Sets the decimal format symbols, which is generally not changed by the programmer or user.

Parameters

symbols

DecimalFormatSymbols.

Stable:

ICU 2.0

Allows you to set the parse behavior of the pattern decimal mark.

if true, the input must have a decimal mark if one was specified in the pattern. When false the decimal mark may be omitted from the input.

Parameters

newValue

set true if input must contain a match to decimal mark in pattern

Stable:

ICU 54

Allows you to set the behavior of the decimal separator with integers.

(The decimal separator will always appear with decimals.)

Parameters

newValue

set true if the decimal separator will always appear with decimals. Example: Decimal ON: 12345 -> 12345.; OFF: 12345 -> 12345

Stable:

ICU 2.0

Set whether the exponent sign is always shown.

This has no effect unless scientific notation is in use.

Parameters

expSignAlways

true if the exponent is always prefixed with either the localized minus sign or the localized plus sign, false if only negative exponents are prefixed with the localized minus sign.

See also

setScientificNotation

isScientificNotation

setMinimumExponentDigits

getMinimumExponentDigits

isExponentSignAlwaysShown

Stable:

ICU 2.0

Sets whether truncation of high-order integer digits should result in an error.

By default, setMaximumIntegerDigits truncates high-order digits silently.

Parameters

value

Whether to set an error code if high-order digits are truncated.

Stable:

ICU 64

Set the width to which the output offormat() is padded.

The width is counted in 16-bit code units. This method also controls whether padding is enabled.

Parameters

width

the width to which to pad the result offormat(), or zero to disable padding. A negative width is equivalent to 0.

See also

getFormatWidth

getPadCharacterString

setPadCharacter

getPadPosition

setPadPosition

Stable:

ICU 2.0

Set the grouping size.

Grouping size is the number of digits between grouping separators in the integer portion of a number. For example, in the number "123,456.78", the grouping size is 3.

Parameters

newValue

the new value of the grouping size.

See also

getGroupingSize

NumberFormat::setGroupingUsed

DecimalFormatSymbols::setGroupingSeparator

Stable:

ICU 2.0

Set whether or not grouping will be used in this format.

Parameters

newValue

True, grouping will be used in this format.

See also

getGroupingUsed

Stable:

ICU 53

Reimplemented fromicu::NumberFormat.

Sets whether lenient parsing should be enabled (it is off by default).

Parameters

enable

true if lenient parsing should be used,false otherwise.

Stable:

ICU 4.8

Reimplemented fromicu::NumberFormat.

Sets the maximum number of digits allowed in the fraction portion of a number.

This override limits the fraction digit count to 340.

Parameters

newValue

the new value of the maximum number of digits allowed in the fraction portion of a number.

See also

NumberFormat::setMaximumFractionDigits

Stable:

ICU 2.0

Reimplemented fromicu::NumberFormat.

Sets the maximum number of digits allowed in the integer portion of a number.

This override limits the integer digit count to 309.

Parameters

newValue

the new value of the maximum number of digits allowed in the integer portion of a number.

See also

NumberFormat::setMaximumIntegerDigits

Stable:

ICU 2.0

Reimplemented fromicu::NumberFormat.

Sets the maximum number of significant digits that will be displayed.

Ifmax is less than one then it is set to one. If the minimum significant digits count is greater thanmax, then it is set tomax. This function also enables the use of significant digits by this formatter -areSignificantDigitsUsed() will return true.

See also

areSignificantDigitsUsed

Parameters

max	the most significant digits to be shown

Stable:

ICU 3.0

Set the minimum exponent digits that will be shown.

This has no effect unless scientific notation is in use.

Parameters

minExpDig

a value >= 1 indicating the fewest exponent digits that will be shown. Values less than 1 will be treated as 1.

See also

setScientificNotation

isScientificNotation

getMinimumExponentDigits

isExponentSignAlwaysShown

setExponentSignAlwaysShown

Stable:

ICU 2.0

Sets the minimum number of digits allowed in the fraction portion of a number.

This override limits the fraction digit count to 340.

Parameters

newValue

the new value of the minimum number of digits allowed in the fraction portion of a number.

See also

NumberFormat::setMinimumFractionDigits

Stable:

ICU 2.0

Reimplemented fromicu::NumberFormat.

Sets the minimum grouping digits.