FormatNumber [VBA]

Renvoie une chaîne avec un formatage de nombre appliqué à une expression numérique.

Icône Avertissement

Cette fonction ou constante est activée avec l'instruction Option VBASupport 1 placée avant le code du programme exécutable dans un module.


Syntaxe :

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

Valeur de retour :

Chaîne

Paramètres :

expression : requis. L'expression numérique à formater.

numDigitsAfterDecimal : facultatif. Une valeur numérique indiquant le nombre chiffres qui doit être affiché après la décimale. Si omis, la valeur par défaut est -1, signifiant que le paramétrage par défaut de la locale de l'interface utilisateur doit être utilisé.

includeLeadingDigit : facultatif. Une valeur d'énumérationvbTriState, indiquant si un zéro non significatif doit être affiché pour les valeurs fractionnelles.

useParensForNegativeNumbers : facultatif. Une valeur d'énumération vbTriState indiquant si les nombres négatifs doivent être entourés par des parenthèses.

groupDigits : facultatif. Une valeur d'énumérationvbTriState indiquant que les nombres doivent être groupés (en milliers, etc.) en utilisant le délimiteur de groupe qui est spécifié dans les paramètres régionaux du système.

Codes d'erreur :

13 le type de données ne correspond pas

Exemple :

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