Module
Contents
Index 🔎︎

# Format Function

Convierte un númberu nuna cadena y dempués da-y formatu acordies coles especificaciones indicaes.

## Sintaxis:

    Format (Númberu [, Formatu As String])

## Valor de torna:

Cadena

## Parámetros:

Númberu: Espresión numbérica que se deseye convertir en cadena con formatu.

Formatu: Cadena qu'especifica'l códigu de formatu pal númberu. Si omítese Formatu:, la función Format actúa como la función Str.

## Códigos de formatu

La llista siguiente describe los códigos que dexen dar formatu a un númberu:

0: Si Númberu tien un díxitu na posición del 0 nel códigu de formatu, amuésase aquél, en casu contrariu amuésase'l valor cero.

Si la espresión Númberu tien menos díxitos que'l númberu de ceros del códigu de formatu (a cualquier llau del decimal), amuésense ceros de rellenu de primeres o a la fin. Si'l númberu tien más díxitos a la izquierda del separador decimal que la cantidá de ceros qu'hai nel códigu de formatu, los díxitos adicionales amosar ensin modificar.

Les posiciones decimales del númberu arredóndiense acordies col númberu de ceros qu'apaecen dempués del separador decimal nel códigu de Format.

#: Si Númberu contién un díxitu na posición del comodín # del códigu de Format, el díxitu amuésase, en casu contrariu nun s'amuesa nada nesa posición.

Esti símbolu funciona como 0, sacante porque los ceros de rellenu anteriores o posteriores nun s'amuesen si hai más caráuteres # nel códigu de formatu que díxitos tien el númberu. Namái s'amuesen los díxitos pertinentes del númberu.

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

Si'l códigu de formatu namái contién comodinos # a la izquierda d'esti símbolu, los númberos menores que 1 empiecen con un separador decimal. Por que s'amuese siempres un cero de rellenu con númberos fraccionarios, use 0 como comodín pal primer díxitu de la esquierda del separador decimal.

%: Multiplica'l númberu por 100 y inxerta el signu de porcentaxe (%) na posición en qu'ésti apaez nel códigu de formatu.

E- E+ e- e+ : Si'l códigu de formatu contién a lo menos un comodín de díxitu (0 o #) a la derecha del símbolu E- E+ e- o e+, al númberu aplícase-y el formatu científicu o esponencial. Les lletres E o e inxertense ente'l númberu y l'esponente. El númberu d'acutos pa díxitos a la derecha del símbolu determina'l númberu de díxitos nel esponente.

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+.

L'allindiador de miles amuésase si'l códigu de formatu contién l'allindiador incluyíu polos comodinos de díxitos (0 o #).

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".

- + $ ( ) espaciu: Los signos más (+), menos (-), dólar ($), espaciu o paréntesis que s'introducen direutamente nel códigu del formatu amuésense como caráuteres lliterales.

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 (" ").

\ : La barra oblicua inversa amuesa'l caráuter siguiente del códigu del formatu.

Los caráuteres del códigu de formatu que tienen un significáu especial namái puen amosase como lliterales si tán precedíos por una barra oblicua inversa. La mesma barra oblicua inversa nun pue amosase nun siendo que se introduza dos vegaes (\\) nel códigu de formatu.

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 (@, &, <, >, !).

Tamién pue usase los formatos numbéricos predefiníos siguientes. Sacante pa "Xeneral Number" tolos códigos de formatu predefiníos devuelven el númberu con dos espacios decimales.

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

## Formatos predefiníos

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).

Un códigu de formatu pue estremase en tres seiciones que se dixebren por caráuteres de puntu y coma. La primer parte define'l formatu pa valores positivos, la segunda pa valores negativos y la tercera pa cero. Si namái s'especifica un códigu de formatu, aplicar a tolos númberos.

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 LibreOffice - Preferencies Ferramientes - Opciones
- 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

## Exemplu:

    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

Temes rellacionaes

Number format codes