FormatNumber [VBA]

Retorna uma cadeia de caracteres com uma formatação numérica aplicada a uma expressão numérica.

warning

Esta função é ativada com a instrução Option VBASupport 1 colocada antes do código executável num módulo.


Sintaxe:

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

Valor de retorno:

String

Parâmetros:

expression: obrigatório. A expressão numérica a ser formatada.

numDigitsAfterDecimal: Opcional. Um valor numérico que especifica o número de dígitos a ser exibido após a decimal. Se omitido, o padrão é -1, significando que a configuração padrão do local para a interface do usuário deve ser usada.

includeLeadingDigit: Opcional. Um valor da enumeração vbTriState, que especifica se zeros à esquerda devem ser exibidos para valores fracionários.

useParensForNegativeNumbers: Optional. Um valor da enumeração vbTriState especificando se valores negativos devem estar entre parênteses.

groupDigits: Opcional. Um valor da enumeração vbTriState especificando que o número deve ser agrupado ( em milhares, etc...), usando o delimitador de grupo especificado nas configurações regionais do sistema.

Códigos de erro:

13 Tipo de dados incompatível

Exemplo:


        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
    

♥ Doe para nosso projeto! ♥