Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XNumberFormats
Description
provides access to multiple NumberFormats.
Developers Guide
OfficeDev - Number Formats

Methods' Summary
getByKey  
queryKeys  
queryKey finds a number format by its format string and returns its key.  
addNew adds a new number format to the list, using a format string.  
addNewConverted adds a new number format to the list, using a format string in a different locale than the desired locale of the resulting number format.  
removeByKey removes a number format from the list.  
generateFormat generates a format string from several parameters without creating an actual number format.  
Methods' Details
getByKey
::com::sun::star::beans::XPropertySet
getByKey( [in] long  nKey );

Returns
a readonly NumberFormatProperties.
queryKeys
sequence< long >
queryKeys( [in] short  nType,
[in] ::com::sun::star::lang::Locale  nLocale,
[in] boolean  bCreate );

Returns
a sequence of the keys of all number formats with the specified type and language.
Parameter nType
the type of number formats to return. Must be one of the NumberFormat constants.
Parameter nLanguage
the language of number formats to return.
Parameter bCreate
true: create new entries if no formats for the selected language exist
false: return an empty list if no formats for the selected language exist
queryKey
long
queryKey( [in] string  aFormat,
[in] ::com::sun::star::lang::Locale  nLocale,
[in] boolean  bScan );

Description
finds a number format by its format string and returns its key.
addNew
long
addNew( [in] string  aFormat,
[in] ::com::sun::star::lang::Locale  nLocale )
raises( MalformedNumberFormatException );

Description
adds a new number format to the list, using a format string.
addNewConverted
long
addNewConverted( [in] string  aFormat,
[in] ::com::sun::star::lang::Locale  nLocale,
[in] ::com::sun::star::lang::Locale  nNewLocale )
raises( MalformedNumberFormatException );

Description
adds a new number format to the list, using a format string in a different locale than the desired locale of the resulting number format.
removeByKey
void
removeByKey( [in] long  nKey );

Description
removes a number format from the list.
generateFormat
string
generateFormat( [in] long  nBaseKey,
[in] ::com::sun::star::lang::Locale  nLocale,
[in] boolean  bThousands,
[in] boolean  bRed,
[in] short  nDecimals,
[in] short  nLeading );

Description
generates a format string from several parameters without creating an actual number format.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.