LibreOffice
LibreOffice 7.2 SDK API Reference
Public Member Functions | List of all members
XNumberFormats Interface Referencepublished

provides access to multiple NumberFormats. More...

import"XNumberFormats.idl";

Inheritance diagram for XNumberFormats:
XInterface NumberFormats

Public Member Functions

com::sun::star::beans::XPropertySet getByKey ([in] long nKey)
 
sequence< long > queryKeys ([in] short nType, [in] com::sun::star::lang::Locale nLocale, [in] boolean bCreate)
 
long queryKey ([in] string aFormat, [in] com::sun::star::lang::Locale nLocale, [in] boolean bScan)
 finds a number format by its format string and returns its key. More...
 
long addNew ([in] string aFormat, [in] com::sun::star::lang::Locale nLocale) raises ( com::sun::star::util::MalformedNumberFormatException )
 adds a new number format to the list, using a format string. More...
 
long addNewConverted ([in] string aFormat, [in] com::sun::star::lang::Locale nLocale, [in] com::sun::star::lang::Locale nNewLocale) raises ( com::sun::star::util::MalformedNumberFormatException )
 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. More...
 
void removeByKey ([in] long nKey)
 removes a number format from the list. More...
 
string generateFormat ([in] long nBaseKey, [in] com::sun::star::lang::Locale nLocale, [in] boolean bThousands, [in] boolean bRed, [in] short nDecimals, [in] short nLeading)
 generates a format string from several parameters without creating an actual number format. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

provides access to multiple NumberFormats.

The number formats are managed by their unique key in the document.

Developers Guide
OfficeDev - Number Formats

Member Function Documentation

◆ addNew()

long addNew ( [in] string  aFormat,
[in] com::sun::star::lang::Locale  nLocale 
)
raises (com::sun::star::util::MalformedNumberFormatException
)

adds a new number format to the list, using a format string.

Returns
the key for new number format
Parameters
aFormatthe string representation of the number format
nLocalethe locale for the number format
Exceptions
com::sun::star::util::MalformedNumberFormatExceptionif incorrect number format is specified

◆ addNewConverted()

long addNewConverted ( [in] string  aFormat,
[in] com::sun::star::lang::Locale  nLocale,
[in] com::sun::star::lang::Locale  nNewLocale 
)
raises (com::sun::star::util::MalformedNumberFormatException
)

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.

Returns
the key for added number format
Parameters
aFormatthe key for the number format
nLocalethe original locale for the number format
nNewLocalethe new locale for the number format to be converted
Exceptions
com::sun::star::util::MalformedNumberFormatExceptionif incorrect number format is specified

◆ 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 
)

generates a format string from several parameters without creating an actual number format.

Returns
the string representation for the number format
Parameters
nBaseKeythe key for the number format to be used as base format
nLocalethe locale for the number format
bThousandsthe thousands separator is shown or not
bRedshow negative number in red colored if TRUE
nDecimalshow many digits are shown after the decimal point
nLeadinghow many number of leading zeros are shown

◆ getByKey()

com::sun::star::beans::XPropertySet getByKey ( [in] long  nKey)
Returns
a readonly NumberFormatProperties.
Parameters
nKeythe key for the format

◆ queryKey()

long queryKey ( [in] string  aFormat,
[in] com::sun::star::lang::Locale  nLocale,
[in] boolean  bScan 
)

finds a number format by its format string and returns its key.

Returns
the key for the format if found, otherwise -1.
Parameters
aFormatthe string representation of the number format
nLocalethe locale for number formats to find
bScanreserved for future use and should be set to false

◆ 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.
Parameters
nTypethe type of number formats to return. Must be one of the NumberFormat constants.
nLocalethe locale of number formats to return.
bCreateTRUE: create new entries if no formats for the selected language exist
FALSE: return an empty list if no formats for the selected language exist

◆ removeByKey()

void removeByKey ( [in] long  nKey)

removes a number format from the list.

Parameters
nKeythe key for the numberformat

The documentation for this interface was generated from the following file: