Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: util ::
interface XNumberFormats
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XNumberFormats
Description provides access to multiple NumberFormat s. Developers Guide 6.2.5 Office Development - Common Application Features - 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 [in] ::com::sun::star::lang::Locale [in] boolean | nType, nLocale, 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 [in] ::com::sun::star::lang::Locale [in] boolean | aFormat, nLocale, bScan );
Description finds a number format by its format string and returns its key.
addNew
long addNew( | [in] string [in] ::com::sun::star::lang::Locale raises( | aFormat, nLocale ) MalformedNumberFormatException );
Description adds a new number format to the list, using a format string.
addNewConverted
long addNewConverted( | [in] string [in] ::com::sun::star::lang::Locale [in] ::com::sun::star::lang::Locale raises( | aFormat, nLocale, nNewLocale ) 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 [in] ::com::sun::star::lang::Locale [in] boolean [in] boolean [in] short [in] short | nBaseKey, nLocale, bThousands, bRed, nDecimals, nLeading );
Description generates a format string from several parameters without creating an actual number format.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.