Contido

# Format Function

Converts a numeric expression to a string, and then formats it according to the format that you specify.

### Sintaxe:

    Format(expression [, format As String]) As String

### Parámetros:

expression: Numeric expression that you want to convert to a formatted string.

format: String that specifies the format code for the number. If format is omitted, the Format function works like the LibreOffice Basic Str() function.

### Return type:

Text string.

## Códigos de formatado

In BASIC, a format code can be divided into three sections that are separated by semicolons. The first part defines the format for positive values, the second part for negative values, and the third part for zero. If you only specify one format code, it applies to all numbers.

You can set the locale used for controlling the formatting numbers, dates and currencies in LibreOffice Basic in LibreOffice - PreferencesTools - Options - Languages and Locales - General. In Basic format codes, the decimal point (.) is always used as placeholder for the decimal separator defined in your locale and will be replaced by the corresponding character.

Aplícase o mesmo na configuración rexional dos formatos de data, hora e moeda. O código de formato de BASIC interprétase e móstrase de acordo coa súa configuración rexional.

The following list describes the codes that you can use for formatting a numeric expression:

Code | Description
--- | ---
0 | If expression has a digit at the position of the 0 in the format code, the digit is displayed, otherwise a zero is displayed. If expression has fewer digits than the number of zeros in the format code, (on either side of the decimal), leading or trailing zeros are displayed. If the expression has more digits to the left of the decimal separator than the amount of zeros in the format code, the additional digits are displayed without formatting. Decimal places in the expression are rounded according to the number of zeros that appear after the decimal separator in the format code.
# | If expression contains a digit at the position of the # placeholder in the format code, the digit is displayed, otherwise nothing is displayed at this position. This symbol works like the 0, except that leading or trailing zeroes are not displayed if there are more # characters in the format code than digits in the expression. Only the relevant digits of the expression are displayed.
. (period) | The decimal placeholder determines the number of decimal places to the left and right of the decimal separator. If the format code contains only # placeholders to the left of this symbol, numbers less than 1 begin with a decimal separator. To always display a leading zero with fractional numbers, use 0 as a placeholder for the first digit to the left of the decimal separator. O uso do punto como separador decimal e de millares depende da configuración rexional. Cando introduza un número directamente no código fonte de BASIC, utilice sempre como separador decimal o punto. O carácter mostrado como separador decimal depende do formato de número do seu sistema.
% | Multiplies the expressionby 100 and inserts the percent sign (%) where the expression appears in the format code.
E- E+ e- e+ | If the format code contains at least one digit placeholder (0 or #) to the right of the symbol E-, E+, e-, or e+, the expression is formatted in the scientific or exponential format. The letter E or e is inserted between the number and the exponent. The number of placeholders for digits to the right of the symbol determines the number of digits in the exponent. Se o expoñente é negativo, o signo menos móstrase directamente antes con E-, E+, e-, e+. Se é positivo, o signo máis só se mostra antes de expoñentes con E+ ou e+.
- + $ ( ) space | : A plus (+), minus (-), dollar ($), space, or brackets entered directly in the format code is displayed as a literal character.
\ | To display characters other than the ones listed here, you must precede it by a backslash (\), or enclose it in quotation marks (" "). The backslash displays the next character in the format code. Characters in the format code that have a special meaning can only be displayed as literal characters if they are preceded by a backslash. The backslash itself is not displayed, unless you enter a double backslash (\\) in the format code. Os caracteres que deben precederse dunha barra invertida no código de formato para mostrarse como caracteres literais son: caracteres de formato de data e hora (a, c, d, h, m, n, p, q, s, t, w, y, /, :), caracteres de formato numérico (#, 0, %, E, e, coma, punto) e caracteres de formato de cadea de caracteres (@, &, <, >, !).

## Predefined formats

You can also use the following predefined number formats. Except for "General Number", all of the predefined format codes return the number as a decimal number with two decimal places.

Se usa formatos predefinidos, o nome do formato debe situarse entre comiñas.

Code | Description
--- | ---
"<" | Convert expression to lower case
">" | Convert expression to upper case.
"c" or "General Date" | Returns the numeric expression in short date format, optionally with "H:MM:SS AM/PM". If expression is a string, returns the string.
"n" | Returns the minute of the numeric expression, with 1 or 2 digits.
"nn" | Returns the minute of the numeric expression with two digits.
"w" | Returns the week day of the numeric expression. 1 is Sunday and 7 is Saturday.
"General Number" | Returns the numeric expression with 12 digits (0.############).
"Currency" | Returns the numeric expression in the currency of the locale.
"Fixed" | Returns the numeric expression with 2 decimal places (0.00).
"Standard" | Returns the numeric expression with thousands separators and 2 decimals (@0.00).
"Percent" | Returns the numeric expression as percent value (0.00%).
"Scientific" | Returns the numeric expression in scientific notation (#.00E+00);
"Yes/No" | Returns "Yes" if the numeric expression is not equal to zero, "No" otherwise. "Yes" and "No" are localized.
"True/False" | Returns "True" if the numeric expression is not equal to zero, "False" otherwise. "True" and "False" are localized.
"On/Off" | Returns "On" if the numeric expression is not equal to zero, "Off" otherwise. "On" and "Off" are localized.
"Long Date" or "dddddd" | Returns the numeric expression in system long date format, and depends on the locale.
"Medium Date" | Returns the numeric expression in date format DD-MMM-YY, and depends on the locale.
"Short Date" or "ddddd" | Returns the numeric expression in system short date format, and depends on the locale.
"Long Time" or "ttttt" | Returns the numeric expression in system long time format, and depends on the locale("H:MM:SS AM/PM").
"Medium Time" | Returns the numeric expression in system medium time format, and depends on the locale (HH:MM AM/PM)
"Short Time" | Returns the numeric expression in system short time format, and depends on the locale (HH:MM).

### Códigos de erro

5 Chamada de procedemento incorrecta

### Exemplo:

    Sub ExampleFormat
        MsgBox Format(6328.2, "##,##0.00")
        REM utilice sempre un punto como separador decimal ao introducir números no código fonte de BASIC.
        REM mostra por exemplo 6,328.20 no contorno local inglés, 6.328,20 no alemán.
    msgbox Format("ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890", "<") ' returns abcdefghijklmnopqrstuvwxyz1234567890, digits not affected.
    msgbox Format("abcdefghijklmnopqrstuvwxyz1234567890", ">") ' returns ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890, digits not affected.
    msgBox Format(12345.6,"c") ' returns the number in date format as 18/10/33 2:24:00 PM in German locale.
    msgBox Format(12345.6,"General Date") ' Same as "c".
    msgbox format(12345.004,"n") ' returns 5
    msgbox format(12345.004,"nn") ' returns 05
    msgbox format(12345.6,"w") ' returns 4 (Wednesday).
    msgbox format(log(123),"General Number") ' returns 4,812184355372 in German locale
    msgbox format(123456.7890,"Fixed") ' 123456.79
    msgbox format(123456.1234,"Fixed") ' 123456.12
    msgbox format(123456.7890,"Standard") '123,456.79
    msgbox format(123456.1234,"Standard") '123,456.12
    msgbox format(12.3456,"Percent") ' 1234.56%
    msgbox format(0.123456,"Percent") '12.35%
    msgbox format(123,"Yes/No") ' returns localized "Yes"
    msgbox format(0,"Yes/No") ' returns localized "No"
    msgbox format(-1,"True/False") ' returns localized "True"
    msgbox format(123,"On/Off") ' returns localized "On"
    msgbox format(45756.73,"Long Date") ' returns Wednesday, April 9, 2025 in your locale
    End Sub

Temas relacionados

Códigos de formatos numéricos

String functions