Format Function

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

Syntax:


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

Parameters:

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 value:

Text string.

Códigos de formatu

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

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.

.: El comodín pa decimales determina'l númberu d'espacios decimales a esquierda y derecha del separador decimal.

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.

%: 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.

Si l'esponente ye negativu, amuésase un signu menos xustu enantes d'un esponente con Y-, Y+, y-, y+. Si l'esponente ye positivu, namái s'amuesa un signu más enantes d'esponentes con Y+ o y+.

The thousands delimiter is displayed if the format code contains the delimiter enclosed by digit placeholders (0 or #).

L'usu d'un puntu como separador de miles y decimal depende del valor de configuración rexonal. El caráuter real que s'amuesa como separador decimal depende del formatu numbéricu de la configuración del sistema. Los exemplos que s'amuesen equí asumen que la configuración rexonal ye "US".

- + $ ( ) space: A plus (+), minus (-), dollar ($), space, or brackets entered directly in the format code is displayed as a literal character.

Pa que s'amuesen caráuteres distintos de los que se llisten equí, ye necesariu precedelos por una barra oblicua inversa (\) o incluyilos ente comines (" ").

\ : 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.

Los caráuteres que tienen de precedese por una barra oblicua inversa nel códigu de formatu por que se amuesen como caráuteres lliterales son: caráuteres de formatu d'hora y fecha (a, c, d, h, m, n, p, q, s, t, w, y, /, :), caráuteres de formatu numbéricu (#, 0, %, Y, y, coma, puntu) y caráuteres de formatu de cadena (@, &, <, >, !).

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.

Si usen formatos predefiníos, el nome del formatu tien d'incluyise ente comines.

Formatu predefiníu

Xeneral Number: Los númberos amuésense tal como s'introducieron.

Currency: Inxerta un signu de dólar delantre del númberu ya inclúi los númberos negativos ente paréntesis.

Fixed: Amuesa siquier un díxitu delantre del separador decimal.

Standard: Amuesa númberos con un separador de miles.

Percent: Multiplica'l númberu por 100 y amestar un signu de porcentaxe.

Cientificu: Amuesa los númberos en formatu científicu (por exemplu, 1,00E+03 pa 1000).

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.

Pue establecer la configuración llocal que se va usar pa controlar el formatu de númberos, dates y monedes en LibreOffice Basic al traviés de - Configuración d'idiomes - Idiomes. En codigos de formatu de Basic, el puntu decimal (.) usase siempres como acuto d'espaciu pal separador decimal definíu na so configuración llocal y trocarase pol carácter correspondiente.

Lo mesmo aplícase a los valores de configuración de los formatos de fecha, hora y moneda. El códigu de formatu de Basic va interpretase y va amosase según los valores de configuración del entornu llocal correspondientes.

Error codes:

5 Llamada a procedimientu non válida

Example:


Sub ExampleFormat
    MsgBox Format(6328.2, "##,##0.00")
    ' usa siempres el puntu como allindiador de decimales al escribir númberos nel códigu fonte de Basic.
    ' por exemplu, amuesa 6,328.20 n'entornu llocal inglés y 6.328,20 n'entornu llocal alemán
End Sub

Please support us!