Función Format

Convierte un número en una cadena y después le da formato de acuerdo con las especificaciones indicadas.

Sintaxis:

Format (Número [, Formato As String])

Valor de retorno:

Cadena

Parámetros:

Número: Expresión numérica que se desee convertir en cadena con formato.

Formato: Cadena que especifica el código de formato para el número. Si se omite Formato, la función Format actúa como la función Str.

Códigos de formato

La lista siguiente describe los códigos que permiten dar formato a un número:

0: Si Número tiene un dígito en la posición del 0 en el código de formato, se muestra aquél, en caso contrario se muestra el valor cero.

Si la expresión Número tiene menos dígitos que el número de ceros del código de formato (a cualquier lado del decimal), se muestran ceros de relleno al principio o al final. Si el número tiene más dígitos a la izquierda del separador decimal que la cantidad de ceros que hay en el código de formato, los dígitos adicionales se muestran sin formateo.

Las posiciones decimales del número se redondean de acuerdo con el número de ceros que aparecen después del separador decimal en el código de Format.

#: Si Número contiene un dígito en la posición del comodín # del código de Format, el dígito se muestra, en caso contrario no se muestra nada en esa posición.

Este símbolo funciona como 0, excepto porque los ceros de relleno anteriores o posteriores no se muestran si hay más caracteres # en el código de formato que dígitos tiene el número. Solo se muestran los dígitos pertinentes del número.

.: El indicador de posición para decimales determina el número de espacios decimales a izquierda y derecha del separador decimal.

Si el código de formato sólo contiene indicadores de posición # a la izquierda de este símbolo, los números menores que 1 empiezan con un separador decimal. Para que se muestre siempre un cero de relleno con números fraccionarios, use 0 como indicador de posición para el primer dígito de la izquierda del separador decimal.

%: Multiplica el número por 100 e inserta el signo de porcentaje (%) en la posición en que éste aparece en el código de formato.

E- E+ e- e+: Si el código de formato contiene por lo menos un comodín de dígito (0 o #) a la derecha del símbolo E-, E+, e- o e+, al número se le aplica el formato científico o exponencial. La letra E o e se inserta entre el número y el exponente. El número de comodines para dígitos a la derecha del símbolo determina la cantidad de dígitos del exponente.

Si el exponente es negativo, se muestra un signo menos justo antes de un exponente con E-, E+, e-, e+. Si el exponente es positivo, sólo se muestra un signo más antes de exponentes con E+ o e+.

El delimitador de miles se muestra si el código de formato contiene el delimitador entre los comodines de dígitos (0 o #).

El uso de un punto como separador de miles y decimal depende del valor de configuración regional. El carácter real que se muestra como separador decimal depende del formato numérico de la configuración del sistema. Los ejemplos que se muestran aquí asumen que la configuración regional es "US".

- + $ ( ) espacio: Los signos más (+), menos (-), dólar ($), espacio o paréntesis que se introducen directamente en el código del formato se muestran como caracteres literales.

Para que se muestren caracteres distintos de los que se indican aquí, es necesario colocarles una contrabarra (\) antes o entrecomillarlos (" ").

\ : La barra oblicua inversa muestra el carácter siguiente del código del formato.

Los caracteres del código de formato que tienen un significado especial solo pueden mostrarse como literales si están precedidos por una contrabarra. La propia contrabarra no puede mostrarse a menos que se digite dos veces (\\) en el código de formato.

Los caracteres que deben precederse por una barra oblicua inversa en el código de formato para que se muestren como caracteres literales son: caracteres de formato de hora y fecha (a, c, d, h, m, n, p, q, s, t, w, y, /, :), caracteres de formato numérico (#, 0, %, E, e, coma, punto) y caracteres de formato de cadena (@, &, <, >, !).

También se puede usar los formatos numéricos predefinidos siguientes. Excepto para "General Number" todos los códigos de formato predefinidos devuelven el número con dos espacios decimales.

Si se usan formatos predefinidos, el nombre del formato debe incluirse entre comillas.

Formatos predefinidos

General Number: Los números se muestran tal como se han introducido.

Currency: Inserta un signo de dólar delante del número e incluye los números negativos entre paréntesis.

Fixed: Muestra al menos un dígito delante del separador decimal.

Standard: Muestra números con un separador de miles.

Percent: Multiplica el número por 100 y le añade un signo de porcentaje.

Scientific: Muestra números en formato científico (por ejemplo, 1,00E+03 para 1000).

Un código de formato puede dividirse en tres secciones que se separan por caracteres de punto y coma. La primera parte define el formato para valores positivos, la segunda para valores negativos y la tercera para cero. Si sólo se especifica un código de formato, se aplica a todos los números.

Puede definir el formato regional de los números, las fechas y las monedas en LibreOffice Basic yendo a ▸ Configuración de idioma ▸ Idiomas. En los códigos de formato de Basic, el punto decimal (.) se utiliza siempre como marcador de posición del separador decimal definido en la configuración regional elegida; este punto se reemplazará por el carácter correspondiente.

Lo mismo se aplica a los valores de configuración de los formatos de fecha, hora y moneda. El código de formato de Basic se interpretará y se mostrará según los valores de configuración del entorno local correspondientes.

Códigos de error:

5 Llamada a procedimiento no válida

Ejemplo:

Sub ExampleFormat

    MsgBox Format(6328.2, "##,##0.00")

    ' utilice siempre el punto como delimitador de decimales al introducir números en el código fuente de Basic.

    ' por ejemplo, muestra 6,328.20 en entorno local inglés y 6.328,20 en entorno local alemán.

End Sub