Módulo
Contenido
Índice 🔎︎

# Función FormatNumber [VBA]

Devuelve una cadena con un formato numérico aplicado a una expresión numérica.

Esta función o constante se activa por medio de la instrucción Option VBASupport 1, colocada antes del código del programa ejecutable de algún módulo.

## Sintaxis:

FormatNumber( expression, numDigitsAfterDecimal as Integer, includeLeadingDigit as Integer, useParensForNegativeNumbers as Integer, groupDigits as Integer )

## Valor de retorno:

Cadena

## Parámetros:

expresión: obligatoria. La expresión numérica que formatear.

numDigitsAfterDecimal: opcional. Un valor numérico que especifica el número de dígitos que deben mostrarse después del separador decimal. Si se omite, su valor predeterminado es -1, lo que significa que se utilizarán los ajustes predeterminados de la configuración regional de la interfaz.

includeLeadingDigit: opcional. Un valor de la enumeración vbTriState que indica si deben mostrarse ceros iniciales en los valores fraccionarios.

- vbTrue o -1: muestra un cero inicial.

- vbFalse o 0: no muestra ceros iniciales.

- vbUseDefaults o -2: utiliza la configuración regional de la interfaz de usuario. Este es el comportamiento predeterminado cuando se omite.

useParensForNegativeNumbers: opcional. Un valor de la enumeración vbTriState que indica si los números negativos deben encerrarse entre paréntesis.

- vbTrue o -1: utiliza paréntesis en los números negativos.

- vbFalse o 0: no muestra paréntesis.

- vbUseDefaults o -2: lo mismo que vbFalse. Este es el comportamiento predeterminado cuando se omite.

groupDigits: Optional. A vbTriState enumeration value specifying the number should be grouped (into thousands, etc.), using the group delimiter that is specified on the system's regional settings.

- vbTrue o -1: agrupa los dígitos.

- vbFalse o 0: no agrupa los dígitos.

- vbUseDefaults o -2: lo mismo que vbFalse. Este es el comportamiento predeterminado cuando se omite.

## Códigos de error:

13 Discordancia de tipo

## Ejemplo:

            Sub TestFormatNumeber
            testName = "Test 1: positive, 2 decimals"
            str2 = "12.20"
            str1 = FormatNumber("12.2", 2, vbFalse, vbFalse, vbFalse)
            msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)

            testName = "Test 2: negative, 20 decimals, use leading zero"
            str2 = "-0.20000000000000000000"
            str1 = FormatNumber("-.2", 20, vbTrue, vbFalse, vbFalse)
            msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)

            testName = "Test 3: negative, 20 decimals, no leading zero"
            str2 = "-.20000000000000000000"
            str1 = FormatNumber("-0.2", 20, vbFalse, vbFalse, vbFalse)
            msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)

            testName = "Test 4: negative, no leading zero, use parens"
            str2 = "(.20)"
            str1 = FormatNumber("-0.2", -1, vbFalse, vbTrue, vbFalse)
            msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)

            testName = "Test 5: negative, default leading zero, use parens"
            str2 = "(0.20)"
            str1 = FormatNumber("-0.2", -1, vbUseDefault, vbTrue, vbFalse)
            msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)

            testName = "Test 6: group digits"
            str2 = "-12,345,678.00"
            str1 = FormatNumber("-12345678", -1, vbUseDefault, vbUseDefault, vbTrue)
            msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)
            End Sub

Temas relacionados

Funciones matemáticas de VBA