FormatNumber [VBA]

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

Esta constante, função ou objeto se ativa com a instrução Option VBASupport 1 colocada antes do código executável do programa em um módulo.

Sintaxe:


        FormatNumber( expression As Variant, [numDigitsAfterDecimal As Integer], [includeLeadingDigit As Integer], _
            [useParensForNegativeNumbers As Integer], [groupDigits As Integer] ) As String

Valor de retorno:

String

Parâmetros:

expression: Requerido. Uma expressão numérica a ser formatada. Se expression é uma cadeia de caracteres, então o separador decimal e de milhar precisa ser localizado.

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 da localidade 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.

vbTrue ou -1: Exibe um zero à esquerda.
vbFalse ou 0: Não mostre zeros à esquerda.
vbUseDefaults ou -2: Utilize as configurações regionais da interface do usuário. Este é o padrão se omitido.

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

vbTrue ou -1: Use parenteses para números negativos.
vbFalse ou 0: Não mostre parênteses.
vbUseDefaults ou -2: O mesmo que vbFalse. Este é o padrão quando omitido.

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.

vbTrue ou -1: agrupar dígitos.
vbFalse ou 0: não agrupar dígitos.
vbUseDefaults ou -2: O mesmo que vbFalse. Este é o padrão quando omitido.

Códigos de erro:

13 Tipo de dados incompatível

Exemplo:


        Sub TestFormatNumber
        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

Funções matemáticas do VBA