Module
Contents
Index 🔎︎

# Format Function

Teisendab arvu stringiks ja vormindab seejärel määratud vormingusse.

## Süntaks:

    Format (arv [, Format As String])

## Tagastusväärtus:

String

## Parameetrid:

Number: arvavaldis, mille soovid teisendada vormindatud stringiks.

Format: string, mis määrab arvu vormingukoodi. Kui parameeter Format jäetakse vahele, siis toimib vormingufunktsioon samamaoodi, nagu funktsioon Str.

## Vormingukoodid

Järgmine loend sisaldab arvu vormindamiseks kasutatavate koodide kirjeldusi.

0: kui parameetris Number on number positisoonil, kus vormingukoodis on 0, siis see number kuvatakse, muul juhul kuvatakse null.

Kui parameetri Number kohtade arv on väiksem kui nullide arv vormingukoodis (mõlemal pool kümnenderaldajat), siis kuvatakse ees- ja lõpunullid. Kui arvus on kümnenderaldaja ees rohkem kohti kui nullide arv vormingukoodis, siis kuvatakse täiendavad numbrid vormindamata.

Arvu kümnendkohad ümardatakse vastavalt kümnenderaldajale järgnevate nullide arvule vormingukoodis.

#: kui parameetris Number on number positisoonil, kus vormingukoodis on kohatäide #, siis see number kuvatakse, muul juhul ei kuvata sellel positsioonil midagi.

See sümbol toimib nagu 0, välja arvatud see, et kui vormingukoodis on rohkem sümboleid # kui arvus numbrikohti, siis ees- ja lõpunulle ei kuvata. Kuvatakse ainult asjakohased numbrikohad.

.: kümnendarvu kohatäide määrab kümnendkohtade arvu kümnenderaldaja ees ja järel.

Kui vormingukood sisaldab sümboli # järel ainult kohatäiteid #, siis algavad arvud, mis on väiksemad kui 1, kümnenderaldajaga. Kui soovid murdarvude korral kuvada alati eesnulli, siis kasuta kümnenderaldajale järgneva esimese numbrikoha kohatäitena 0.

%: korrutab arvu 100-ga ja lisab vormingukoodis protsendimärgi (%).

E- E+ e- e+ : kui vormingukoodis on sümboli E-, E+, e-, või e+ ees vähemalt üks numbrikoha kohatäide (0 või #), kasutatakse arvu vormindamisel teaduslikku või eksponentvormingut. Täht E või e lisatakse arvu ja eksponendi vahele. Numbrikohtade kohatäidete arv sümboli järel määrab eksponendi numbrikohtade arvu.

Kui eksponent on negatiivne, kuvatakse sümboliga E-, E+, e- või e+ eksponendi ees miinusmärk. Kui eksponent on positiivne, kuvatakse plussmärk ainult sümboliga E+ või e+ eksponendi ees.

Tuhandike eraldaja kuvatakse siis, kui vormingukood sisaldab eraldajat, millele on lisatud numbrikohtae kohatäited (0 või #).

Punkti kasutamine tuhandike ja kümnenderaldajana sõltub piirkonnasätetst. Kui sisestad arvu otse Basicu lähtekoodi, siis kasuta kümnenderaldajana alati punkti. Kümnenderaldajana tegelikult kuvatav märk sõltub süsteemisätetega määratud arvuvormingust.

- + $ ( ) tühik: otse vormingukoodi sisestatud plussmärk (+), miinusmärk (-), dollari sümbol ($), tühik või sulud kuvatakse literaalmärgina.

Nende märkide kuvamiseks, mida selles loendi pole, pead märgi ette lisama kurakriipsu (\) või sisestama märgi jutumärkides (" ").

\ : kurakriipsu korral kuvatakse vormingukoodi järgmine märk.

Vormingukoodi eritähendusega märke saab literaalmärkidena kuvada ainult siis, kui märgi ette on lisatud kurakriips. Kurakriipsu ei kuvata, v. a juhul, kui sisestad vormingukoodi topeltkurakriipsu (\\).

Märgid, mille kuvamiseks literaalmärkidena peab vormingukoodis nende ees olema kurakriips, on kuupäeva- ja kellaajavormingu märgid (a, c, d, h, m, n, p, q, s, t, w, y, /, :), arvuvormingumärgid (#, 0, %, E, e, koma, punkt) ja stringivormingumärgid (@, &, <, >, !).

Soovi korral saad kasutada ka järgmisi eelmääratud arvuvorminguid. Kõik eelmääratud vormingukoodid (v.a General Number) tagastavad arvuna kahe kümnendkohaga kümnendarvu.

Kui kasutad eelmääratud vorminguid, siis tuleb sulgudesse lisada vormingu nimi.

## Eeldefineeritud vorming

General Number: Arve näidatakse sellisel kujul, nagu nad sisestatakse.

Currency: Lisab arvu ette dollarimärgi ning ümbritseb negatiivsed arvud sulgudega.

Fixed: kuvab vähemalt ühe koha kümnenderaldaja ees.

Standard: Näitab arve tuhandeliste eraldajaga.

Percent: Korrutab arvu sajaga ning lisab tulemusele protsendimärgi.

Scientific: Näitab numbreid teaduslikul kujul (näiteks 1000 on 1.00E+03).

Vormingukood saab jaotada kolmeks semikooloniga eraldatud sektsiooniks. Esimene osa määrab positiivsete väärtuste vormingu, teine osa negatiivsete väärtuste vormingu ja kolmas nulli vormingu. Kui määrad ainult ühe vormingukoodi, siis kehtib see kõigi arvude jaoks.

Arvu-, kuupäeva- ja valuutavormingu määramiseks LibreOffice Basicus vali LibreOffice - EelistusedTööriistad - Sätted - Keelesätted - Keeled ning määra sobiv lokaat. Basicu vormingukoodides kasutatakse lokaadijärgse kümnendkohtade eraldaja kohahoidjana alati punkti (.), mis asendatakse vastava märgiga.

Sama kehtib ka kuupäeva-, kellaaja- ja valuutavormingu lokaadisätete kohta. Basicu vormingukoodi tõlgendatakse ja kuvatakse vastavalt määratud lokaadisätetele.

## Error codes:

5 Vigane protseduuri väljakutse

## Näide:

    Sub ExampleFormat
        MsgBox Format(6328.2, "##,##0.00")
        REM Arvude sisestamisel Basicu lähtekoodi kasuta kümnenderaldajana alati punkti.
        REM kuvab näiteks Inglise lokaadisätete korral 6,328.20 ja Saksa lokaadisätete korral 6.328,20.
    End Sub

Sarnased teemad

Number format codes