:: com :: sun :: star :: util ::

interface XNumberFormatter
Base Hierarchy
::com::sun::star::uno::XInterface
 |
 +-XNumberFormatter
Description
represents a number formatter.
Developers Guide
6.2.5 Office Development - Common Application Features - Number Formats

Methods' Summary
attachNumberFormatsSupplier attaches an XNumberFormatsSupplier to this NumberFormatter .
getNumberFormatsSupplier
detectNumberFormat detects the number format in a string which contains a formatted number.
convertStringToNumber converts a string which contains a formatted number into a number.
convertNumberToString converts a number into a string.
queryColorForNumber
formatString converts a string into another string.
queryColorForString
getInputString converts a number into a string with the specified format.
Methods' Details
attachNumberFormatsSupplier
void
attachNumberFormatsSupplier(
 
[in] XNumberFormatsSupplier
 
xSupplier );

Description
attaches an XNumberFormatsSupplier to this NumberFormatter .

This NumberFormatter will only use the NumberFormats specified in the attached XNumberFormatsSupplier . Without an attached XNumberFormatsSupplier , no formatting is possible.

getNumberFormatsSupplier
XNumberFormatsSupplier
getNumberFormatsSupplier();
 
 

Returns
the attached XNumberFormatsSupplier .
detectNumberFormat
long
detectNumberFormat(
 
[in] long
[in] string 

raises(

 
nKey,
aString ) 
NotNumericException );

Description
detects the number format in a string which contains a formatted number.
convertStringToNumber
double
convertStringToNumber(
 
[in] long
[in] string 

raises(

 
nKey,
aString ) 
NotNumericException );

Description
converts a string which contains a formatted number into a number.

If this is a text format, the string will not be converted.

convertNumberToString
string
convertNumberToString(
 
[in] long
[in] double
 
nKey,
fValue );

Description
converts a number into a string.
queryColorForNumber
color
queryColorForNumber(
 
[in] long
[in] double
[in] color
 
nKey,
fValue,
aDefaultColor );

Returns
the color which is specified for the given value in the number format, which is otherwise the value of aDefaultColor .
formatString
string
formatString(
 
[in] long
[in] string
 
nKey,
aString );

Description
converts a string into another string.
queryColorForString
color
queryColorForString(
 
[in] long
[in] string
[in] color
 
nKey,
aString,
aDefaultColor );

Returns
the color which is specified for the given string in the number format, which is otherwise the value of aDefaultColor .
getInputString
string
getInputString(
 
[in] long
[in] double
 
nKey,
fValue );

Description
converts a number into a string with the specified format.

This string can always be converted back to a number using the same format.

Top of Page