Sisällys

# Format Function

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

### Syntaksi:

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

### Parametrit:

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.

### Paluuarvo:

Text string.

## Muotoilukoodit

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.

.: Desimaalipaikanvaraaja määrää desimaalien määrän desimaalierottimen vasemmalla ja oikealla puolella.

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.

Eksponentin ollessa negatiivinen, miinusmerkki esitetään välittömästi eksponentin edessä kaikilla koodeilla E-, E+, e- ja e+. Positiivisen eksponentin plusmerkki esitetään vain koodeilla E+ ja e+.

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

Pisteen käyttö tuhat- tai desimaalierottimena on riippuvainen maa-asetuksista. Kun numeroita kirjoitetaan suoraan Basicin lähdekoodiin, desimaalierottimena käytetään aina pistettä. Todellinen desimaalierottimena näytettävä merkki riippuu käyttöjärjestelmän lukumuotoasetuksista.

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

Muiden kuin tässä esitettyjen merkkien esittämiseksi pitää käyttää joko edeltävää kenoviivaa (\), tai sulkea merkki lainausmerkkeihin (" ").

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

Ne merkit, joita pitää edeltää kenoviiva, että ne esitettäisiin sellaisinaan kirjaimellisesti, ovat päivämäärien ja kellonaikojen muotoilumerkit (a, c, d, h, m, n, p, q, s, t, w, y, /, :), lukumuotoilumerkit (#, 0, %, E, e, pilkku, piste)ja merkkijonojen muotoilumerkit (@, &, <, >, !).

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.

Kun esimääriteltyjä lukumuotoja käytetään, muotoilun avainsana pitää sulkea lainausmerkkeihin.

## Esimääritelty muotoilu

General Number: luvut esitetään niin kuin ne on syötettykin.

Currency: maakohtainen valuuttamerkki esitetään asiaan kuuluvalla paikallaan ja negatiiviset luvut esitetään sulkeissa.

Fixed: desimaalierottimen edessä esitetään aina vähintään yksi numero.

Standard: luvut esitetään tuhaterottimin.

Percent: luku kerrotaan 100:lla ja prosenttimerkki lisätään luvun loppuun.

Scientific: Displays numbers in scientific format (for example, 1.00E+03 for 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 LibreOffice - Preferences Tools - 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.

Sama koskee päivämäärän, ajan ja valuutan muotoiluja. Basicin muotoilukoodi tulkitaan ja esitetään lokaaliasetuksen mukaisesti.

### Virhekoodit:

5 Virheellinen proseduurikutsu

### Esimerkki:

    Sub ExampleFormat
        MsgBox Format(6328.2, "##,##0.00")
        ' Basic-lähdekoodissa käytetään aina pistettä desimaalierottimena.
        ' esitetään esimerkiksi englanninkielisessä lokaalissa muodossa 6,328.20 ja saksankielisessä lokaalissa muodossa 6.328,20.
    End Sub

Aiheeseen liittyvää

Number format codes

Merkkijonofunktiot