Constants' Group NumberFormatIndex

Overview

Module

Use

Devguide

Index

Constants

Constants' Details

:: com :: sun :: star :: i18n ::

constants group NumberFormatIndex

Description

Number format indices to be passed as the index argument to XNumberFormatCode::getFormatCode() or ::com::sun::star::util::XNumberFormatTypes::getFormatIndex().

Each locale can support up to about 5000 arbitrary format codes. But for backward compatiblity reasons, each locale MUST support some predefined format codes. These predefined format codes are accessed through indices as the following, and the locale data format code definitions in i18npool\source\localedata\data\*.xml MUST have matching entries in the form
<FormatElement formatindex="0">
(see also FormatElement::formatIndex). The index values are also used to define the enum NfIndexTableOffset in file svtools/inc/zforlist.hxx

Note: This index has nothing to do with the index key used internally by the number formatter.

Date formats may have a comment of DIN/EN/ISO, meaning

DIN 5008 (Deutsche Industrie Norm)
EN 28601 (European Norm)
ISO 8601 (International Standards Organisation)

Some names of date format constants indicate a special behavior of those formats in StarOffice 5.2 or older. Those are:

DATE_SYSTEM_...: On Windows platforms these formats were entirely retrieved from the system's Regional Settings. OpenOffice.org / StarOffice 6 don't use those Windows settings anymore in order to provide the same functionality and document layout on every platform. Like all other formats these formats are now defined in the i18n framework locale data files under i18npool\source\localedata\data\*.xml
DATE_SYS_...: On Windows platforms these formats used separators and YMD order retrieved from the Regional Settings, but appearance of short/long days/months/years was defined by the application.
DATE_DEF_...: The format code was hard defined, only the date separator was taken from the Windows Regional Settings, but not the YMD order.

Constants
NUMBER_START	Start of simple numerical formats (first format)
NUMBER_STANDARD	The "General" standard format
NUMBER_INT	0 Integer number
NUMBER_DEC2	0.00 Decimal number with 2 decimals
NUMBER_1000INT	#,##0 Integer number with group separator
NUMBER_1000DEC2	#,##0.00 Decimal number with group separator
NUMBER_SYSTEM	#,##0.00 In SO5/Win this format was retrieved from the Regional Settings
NUMBER_END	End of simple numerical formats (last format)
SCIENTIFIC_START	Start of Scientific formats (first format)
SCIENTIFIC_000E000	0.00E+000 Number in scientific notation with exponent in 3 digit placeholders
SCIENTIFIC_000E00	0.00E+00 Number in scientific notation with exponent in 2 digit placeholders
SCIENTIFIC_END	End of Scientific formats (last format)
PERCENT_START	Start of Percent formats (first format)
PERCENT_INT	0% Percentage format, rounded to integer
PERCENT_DEC2	0.00% Percentage format, rounded to 2 decimals
PERCENT_END	End of Percent formats (last format)
FRACTION_START	Start of Fraction formats (first format)
FRACTION_1	# ?/? Number with decimal in fraction in 1 digit placeholder
FRACTION_2	# ??/?? Number with decimal in fraction in 2 digit placeholders
FRACTION_END	End of Fraction formats (last format)
CURRENCY_START	Start of Currency formats (first format)
CURRENCY_1000INT	#,##0 DM Integer currency format with group separator
CURRENCY_1000DEC2	#,##0.00 DM Decimal currency format with group separator
CURRENCY_1000INT_RED	#,##0 DM Integer currency format with negative in red
CURRENCY_1000DEC2_RED	#,##0.00 DM Decimal currency format with negative in red
CURRENCY_1000DEC2_CCC	#,##0.00 DEM Currency in ISO-4217 abbreviation format
CURRENCY_1000DEC2_DASHED	#,##0.-- DM Currency format with dash representing 0 in decimals
CURRENCY_END	End of Currency formats (last format)
DATE_START	Start of Date formats (first format)
DATE_SYSTEM_SHORT	08.10.97 see also DATE_SYSTEM_... explanation
DATE_SYSTEM_LONG	Wednesday, 8. October 1997 see also DATE_SYSTEM_... explanation
DATE_SYS_DDMMYY	08.10.97 see also DATE_SYS_... explanation
DATE_SYS_DDMMYYYY	08.10.1997 see also DATE_SYS_... explanation Note: When editing already existing date data this format is forced in order to always edit the full century.
DATE_SYS_DMMMYY	8. Oct 97 see also DATE_SYS_... explanation
DATE_SYS_DMMMYYYY	8. Oct 1997 see also DATE_SYS_... explanation
DATE_DIN_DMMMYYYY	8. Oct. 1997 DIN/EN
DATE_SYS_DMMMMYYYY	8. October 1997 see also DATE_SYS_... explanation
DATE_DIN_DMMMMYYYY	8. October 1997 DIN/EN
DATE_SYS_NNDMMMYY	Wed, 8. Oct 97 see also DATE_SYS_... explanation
DATE_DEF_NNDDMMMYY	Wed 08.Oct 97 see also DATE_DEF_... explanation
DATE_SYS_NNDMMMMYYYY	Wed, 8. October 1997 see also DATE_SYS_... explanation
DATE_SYS_NNNNDMMMMYYYY	Wednesday, 8. October 1997
DATE_DIN_MMDD	10-08 DIN/EN
DATE_DIN_YYMMDD	97-10-08 DIN/EN/ISO
DATE_DIN_YYYYMMDD	1997-10-08 DIN/EN/ISO
DATE_SYS_MMYY	10.97 see also DATE_SYS_... explanation
DATE_SYS_DDMMM	08.Oct see also DATE_SYS_... explanation
DATE_MMMM	October
DATE_QQJJ	4th quarter 97
DATE_WW	week of year
DATE_END	End of Date formats (last format)
TIME_START	Start of Time formats (first format)
TIME_HHMM	HH:MM Time format with hour and minute
TIME_HHMMSS	HH:MM:SS Time format with hour, minute and second
TIME_HHMMAMPM	HH:MM AM/PM Time format with hour, minute and morning/afternoon notation
TIME_HHMMSSAMPM	HH:MM:SS AM/PM Time format with hour, minute, second and morning/afternoon notation
TIME_HH_MMSS	[HH]:MM:SS Time format with amount of hours
TIME_MMSS00	MM:SS,00 Time format with second in fraction
TIME_HH_MMSS00	[HH]:MM:SS,00 Time format with amount of hours and seconds with fraction
TIME_END	End of Time formats (last format)
DATETIME_START	Start of DateTime formats (first format)
DATETIME_SYSTEM_SHORT_HHMM	08.10.97 01:23 Date/time format
DATETIME_SYS_DDMMYYYY_HHMMSS	08.10.1997 01:23:45 Date/time format with second Note: When editing already existing date/time data this format is forced in order to always edit the full century.
DATETIME_END	End of DateTime formats (last format)
BOOLEAN	BOOLEAN format @ATTENTION Not defined in locale data, but generated by the number formatter. If you want to access this format you MUST do it via ::com::sun::star::util::XNumberFormatTypes::getFormatIndex() instead of XNumberFormatCode::getFormatCode().
TEXT	Text format @ATTENTION Not defined in locale data, but generated by the number formatter. If you want to access this format you MUST do it via ::com::sun::star::util::XNumberFormatTypes::getFormatIndex() instead of XNumberFormatCode::getFormatCode()
INDEX_TABLE_ENTRIES	count of built-in format codes.

Constants' Details

NUMBER_START

const short NUMBER_START = 0; Description Start of simple numerical formats (first format)

NUMBER_STANDARD

const short NUMBER_STANDARD = NUMBER_START; Description The "General" standard format

NUMBER_INT

const short NUMBER_INT = NUMBER_START+1; Description 0 Integer number

NUMBER_DEC2

const short NUMBER_DEC2 = NUMBER_START+2; Description 0.00 Decimal number with 2 decimals

NUMBER_1000INT

const short NUMBER_1000INT = NUMBER_START+3; Description #,##0 Integer number with group separator

NUMBER_1000DEC2

const short NUMBER_1000DEC2 = NUMBER_START+4; Description #,##0.00 Decimal number with group separator

NUMBER_SYSTEM

const short NUMBER_SYSTEM = NUMBER_START+5; Description #,##0.00 In SO5/Win this format was retrieved from the Regional Settings

NUMBER_END

const short NUMBER_END = NUMBER_SYSTEM ; Description End of simple numerical formats (last format)

SCIENTIFIC_START

const short SCIENTIFIC_START = NUMBER_END+1; Description Start of Scientific formats (first format)

SCIENTIFIC_000E000

const short SCIENTIFIC_000E000 = SCIENTIFIC_START; Description 0.00E+000 Number in scientific notation with exponent in 3 digit placeholders

SCIENTIFIC_000E00

const short SCIENTIFIC_000E00 = SCIENTIFIC_START+1; Description 0.00E+00 Number in scientific notation with exponent in 2 digit placeholders

SCIENTIFIC_END

const short SCIENTIFIC_END = SCIENTIFIC_000E00; Description End of Scientific formats (last format)

PERCENT_START

const short PERCENT_START = SCIENTIFIC_END+1; Description Start of Percent formats (first format)

PERCENT_INT

const short PERCENT_INT = PERCENT_START; Description 0% Percentage format, rounded to integer

PERCENT_DEC2

const short PERCENT_DEC2 = PERCENT_START+1; Description 0.00% Percentage format, rounded to 2 decimals

PERCENT_END

const short PERCENT_END = PERCENT_DEC2; Description End of Percent formats (last format)

FRACTION_START

const short FRACTION_START = PERCENT_END+1; Description Start of Fraction formats (first format)

FRACTION_1

const short FRACTION_1 = FRACTION_START; Description # ?/? Number with decimal in fraction in 1 digit placeholder

FRACTION_2

const short FRACTION_2 = FRACTION_START+1; Description # ??/?? Number with decimal in fraction in 2 digit placeholders

FRACTION_END

const short FRACTION_END = FRACTION_2; Description End of Fraction formats (last format)

CURRENCY_START

const short CURRENCY_START = FRACTION_END+1; Description Start of Currency formats (first format)

CURRENCY_1000INT

const short CURRENCY_1000INT = CURRENCY_START; Description #,##0 DM Integer currency format with group separator

CURRENCY_1000DEC2

const short CURRENCY_1000DEC2 = CURRENCY_START+1; Description #,##0.00 DM Decimal currency format with group separator

CURRENCY_1000INT_RED

const short CURRENCY_1000INT_RED = CURRENCY_START+2; Description #,##0 DM Integer currency format with negative in red

CURRENCY_1000DEC2_RED

const short CURRENCY_1000DEC2_RED = CURRENCY_START+3; Description #,##0.00 DM Decimal currency format with negative in red

CURRENCY_1000DEC2_CCC

const short CURRENCY_1000DEC2_CCC = CURRENCY_START+4; Description #,##0.00 DEM Currency in ISO-4217 abbreviation format

CURRENCY_1000DEC2_DASHED

const short CURRENCY_1000DEC2_DASHED = CURRENCY_START+5; Description #,##0.-- DM Currency format with dash representing 0 in decimals

CURRENCY_END

const short CURRENCY_END = CURRENCY_1000DEC2_DASHED; Description End of Currency formats (last format)

DATE_START

const short DATE_START = CURRENCY_END+1; Description Start of Date formats (first format)

DATE_SYSTEM_SHORT

const short DATE_SYSTEM_SHORT = DATE_START; Description 08.10.97 see also DATE_SYSTEM_... explanation

DATE_SYSTEM_LONG

const short DATE_SYSTEM_LONG = DATE_START+1; Description Wednesday, 8. October 1997 see also DATE_SYSTEM_... explanation

DATE_SYS_DDMMYY

const short DATE_SYS_DDMMYY = DATE_START+2; Description 08.10.97 see also DATE_SYS_... explanation

DATE_SYS_DDMMYYYY

const short DATE_SYS_DDMMYYYY = DATE_START+3; Description 08.10.1997 see also DATE_SYS_... explanation Note: When editing already existing date data this format is forced in order to always edit the full century.

DATE_SYS_DMMMYY

const short DATE_SYS_DMMMYY = DATE_START+4; Description 8. Oct 97 see also DATE_SYS_... explanation

DATE_SYS_DMMMYYYY

const short DATE_SYS_DMMMYYYY = DATE_START+5; Description 8. Oct 1997 see also DATE_SYS_... explanation

DATE_DIN_DMMMYYYY

const short DATE_DIN_DMMMYYYY = DATE_START+6; Description 8. Oct. 1997 DIN/EN

DATE_SYS_DMMMMYYYY

const short DATE_SYS_DMMMMYYYY = DATE_START+7; Description 8. October 1997 see also DATE_SYS_... explanation

DATE_DIN_DMMMMYYYY

const short DATE_DIN_DMMMMYYYY = DATE_START+8; Description 8. October 1997 DIN/EN

DATE_SYS_NNDMMMYY

const short DATE_SYS_NNDMMMYY = DATE_START+9; Description Wed, 8. Oct 97 see also DATE_SYS_... explanation

DATE_DEF_NNDDMMMYY

const short DATE_DEF_NNDDMMMYY = DATE_START+10; Description Wed 08.Oct 97 see also DATE_DEF_... explanation

DATE_SYS_NNDMMMMYYYY

const short DATE_SYS_NNDMMMMYYYY = DATE_START+11; Description Wed, 8. October 1997 see also DATE_SYS_... explanation

DATE_SYS_NNNNDMMMMYYYY

const short DATE_SYS_NNNNDMMMMYYYY = DATE_START+12; Description Wednesday, 8. October 1997

DATE_DIN_MMDD

const short DATE_DIN_MMDD = DATE_START+13; Description 10-08 DIN/EN

DATE_DIN_YYMMDD

const short DATE_DIN_YYMMDD = DATE_START+14; Description 97-10-08 DIN/EN/ISO

DATE_DIN_YYYYMMDD

const short DATE_DIN_YYYYMMDD = DATE_START+15; Description 1997-10-08 DIN/EN/ISO

DATE_SYS_MMYY

const short DATE_SYS_MMYY = DATE_START+16; Description 10.97 see also DATE_SYS_... explanation

DATE_SYS_DDMMM

const short DATE_SYS_DDMMM = DATE_START+17; Description 08.Oct see also DATE_SYS_... explanation

DATE_MMMM

const short DATE_MMMM = DATE_START+18; Description October

DATE_QQJJ

const short DATE_QQJJ = DATE_START+19; Description 4th quarter 97

DATE_WW

const short DATE_WW = DATE_START+20; Description week of year

DATE_END

const short DATE_END = DATE_WW; Description End of Date formats (last format)

TIME_START

const short TIME_START = DATE_END+1; Description Start of Time formats (first format)

TIME_HHMM

const short TIME_HHMM = TIME_START; Description HH:MM Time format with hour and minute

TIME_HHMMSS

const short TIME_HHMMSS = TIME_START+1; Description HH:MM:SS Time format with hour, minute and second

TIME_HHMMAMPM

const short TIME_HHMMAMPM = TIME_START+2; Description HH:MM AM/PM Time format with hour, minute and morning/afternoon notation

TIME_HHMMSSAMPM

const short TIME_HHMMSSAMPM = TIME_START+3; Description HH:MM:SS AM/PM Time format with hour, minute, second and morning/afternoon notation

TIME_HH_MMSS

const short TIME_HH_MMSS = TIME_START+4; Description [HH]:MM:SS Time format with amount of hours

TIME_MMSS00

const short TIME_MMSS00 = TIME_START+5; Description MM:SS,00 Time format with second in fraction

TIME_HH_MMSS00

const short TIME_HH_MMSS00 = TIME_START+6; Description [HH]:MM:SS,00 Time format with amount of hours and seconds with fraction

TIME_END

const short TIME_END = TIME_HH_MMSS00; Description End of Time formats (last format)

DATETIME_START

const short DATETIME_START = TIME_END + 1; Description Start of DateTime formats (first format)

DATETIME_SYSTEM_SHORT_HHMM

const short DATETIME_SYSTEM_SHORT_HHMM = DATETIME_START; Description 08.10.97 01:23 Date/time format

DATETIME_SYS_DDMMYYYY_HHMMSS

const short DATETIME_SYS_DDMMYYYY_HHMMSS = DATETIME_START+1; Description 08.10.1997 01:23:45 Date/time format with second Note: When editing already existing date/time data this format is forced in order to always edit the full century.

DATETIME_END

const short DATETIME_END = DATETIME_SYS_DDMMYYYY_HHMMSS; Description End of DateTime formats (last format)

BOOLEAN

const short BOOLEAN = DATETIME_END+1; Description BOOLEAN format @ATTENTION Not defined in locale data, but generated by the number formatter. If you want to access this format you MUST do it via ::com::sun::star::util::XNumberFormatTypes::getFormatIndex() instead of XNumberFormatCode::getFormatCode().

TEXT

const short TEXT = BOOLEAN+1; Description Text format @ATTENTION Not defined in locale data, but generated by the number formatter. If you want to access this format you MUST do it via ::com::sun::star::util::XNumberFormatTypes::getFormatIndex() instead of XNumberFormatCode::getFormatCode()

INDEX_TABLE_ENTRIES

const short INDEX_TABLE_ENTRIES = TEXT+1; Description count of built-in format codes.

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous