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.

Formataj kodoj

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.

.: La dekuma lokokupilo difinas la nombron da dekumaj lokoj maldekstre kaj dekstre de la dekuma markilo.

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.

Se la eksponento estas negativa, minusa signumo vidiĝos ĵus antaŭ la eksponento kun E-, E+, e-, e+. Se la eksponento estas pozitiva, plusa signumo vidiĝos nur antaŭ eksponentoj kun E+ or e+.

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

La uzado de punkto kiel disigilo de miloj ka dekuma markilo dependas de la regiona atributo. Kiam oni tajpas nombron en Basic fontkodon, ĉiam uzu punkton kiel la dekuman markilon. La signo eventuale vidigota por la dekuma markilo dependas de la nombra formato en la sistemaj agordoj.

- + $ ( ) 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.

Signoj, kiujn deklivo devas antaŭi en la formata kodo por ke ili vidiĝu laŭlitere kiel signoj, estas dat- kaj taghor-formataj signoj (a, c, d, h, m, n, p, q, s, t, w, y, /, :), numer-formataj signoj (#, 0, %, E, e, komo, punkto), kaj ĉen-formataj signoj (@, &, <, >, !).

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 oni uzas apriorajn formatojn, la nomo de la formato devas esti en citiloj.

Apriora formato

General Number: Nombroj vidiĝos kiel tajpitaj.

Currency: (kurza) enmetas dolaran signumon antaŭ la nombro kaj enmetas negativajn nombrojn en krampojn.

Fixed: Vidigas almenaŭ unu ciferon antaŭ la dekuma markilo.

Standard: Vidigas nombrojn kun disigilo de miloj.

Percent: Multiplikas la nombron per 100 kaj postgluas elcentan signumon post la nombro.

Scientific: Vidigas nombrojn laŭ scienca formato (ekzemple, 1.00E+03 por 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.

You can set the locale used for controlling the formatting numbers, dates and currencies in LibreOffice Basic in - 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.

The same applies to the locale settings for date, time and currency formats. The Basic format code will be interpreted and displayed according to your locale setting.

Error codes:

5 Nevalida procedurvoko

Example:


Sub ExampleFormat
    MsgBox Format(6328.2, "##,##0.00")
    REM Ĉiam uzu punkton kiel dekuman markilon por nombroj en Basic-fontkodo.
    REM vidigas ekzemple 6,328.20 en angla lokaĵaro, 6.328,20 en germana lokaĵaro.
End Sub

Number format codes

String functions