FormatNumber [VBA]

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

Esta constante, função ou objeto é ativado através da instrução Option VBASupport 1, colocada antes do código executável do programa num módulo.

Sintaxe:


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

Tipo de retorno:

String

Parâmetros:

expressão: Obrigatório. Uma expressão numérica a formatar. Se expressão for uma cadeia de caracteres, os separadores decimais e de milhares têm de ser localizados.

numDigitsAfterDecimal: Opcional. Um valor numérico que especifica o número de dígitos que devem ser apresentados após a vírgula decimal. Se for omitido, o valor predefinido é -1, o que significa que devem ser utilizadas as definições predefinidas para a localização da interface do utilizador.

includeLeadingDigit: Opcional. Um valor de enumeração vbTriState, que especifica se deve ser exibido um zero à esquerda para valores fracionários.

vbTrue ou -1: Exibe um zero à esquerda.
vbFalse ou 0: Não exibir zeros à esquerda.
vbUseDefault ou -2: Utiliza as definições de localização da interface do utilizador. Esta é a opção predefinida quando não for especificada.

useParensForNegativeNumbers: Opcional. Um valor de enumeração vbTriState que especifica se os números negativos devem ser colocados entre parênteses.

vbTrue ou -1: Utilize parênteses para os números negativos.
vbFalse ou 0: Não exibir parênteses.
vbUseDefault ou -2: Equivale a vbFalse. É o valor predefinido quando omitido.

groupDigits: Opcional. Um valor de enumeração vbTriState que especifica se o número deve ser agrupado (em milhares, etc.), utilizando o delimitador de agrupamento definido nas definições regionais do sistema.

vbTrue ou -1: Agrupar dígitos.
vbFalse ou 0: Não agrupar dígitos.
vbUseDefault ou -2: Equivale a vbFalse. É o valor predefinido quando omitido.

Códigos de erro

13 Disparidade no tipo de dados

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