LibreOffice
LibreOffice 6.4 SDK API Reference
Public Attributes | List of all members
FormatElement Struct Referencepublished

One number format code and its attributes, returned in a sequence by XLocaleData::getAllFormats(). More...

import"FormatElement.idl";

Public Attributes

string formatCode
 The format code, for example, "YYYY-MM-DD". More...
 
string formatName
 A name or description that is displayed in the number formatter dialog. More...
 
string formatKey
 A unique (within one locale) identifier. More...
 
string formatType
 Type may be one of "short", "medium", "long". More...
 
string formatUsage
 Usage category, for example, "DATE" or "FIXED_NUMBER", corresponding with KNumberFormatUsage values. More...
 
short formatIndex
 The index used by the number formatter, predefined values corresponding with NumberFormatIndex values. More...
 
boolean isDefault
 If a format code is the default code of a formatType group. More...
 

Detailed Description

One number format code and its attributes, returned in a sequence by XLocaleData::getAllFormats().

Contains raw data defined in the XML locale data files.

See also
XLocaleData for links to DTD of XML locale data files.

Member Data Documentation

◆ formatCode

string formatCode

The format code, for example, "YYYY-MM-DD".

◆ formatIndex

short formatIndex

The index used by the number formatter, predefined values corresponding with NumberFormatIndex values.

◆ formatKey

string formatKey

A unique (within one locale) identifier.

◆ formatName

string formatName

A name or description that is displayed in the number formatter dialog.

◆ formatType

string formatType

Type may be one of "short", "medium", "long".

◆ formatUsage

string formatUsage

Usage category, for example, "DATE" or "FIXED_NUMBER", corresponding with KNumberFormatUsage values.

◆ isDefault

boolean isDefault

If a format code is the default code of a formatType group.


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