FormatNumber [VBA]

Restituisce una stringa con la formattazione di un numero applicata a un'espressione numerica.

Icona di avvertenza

Questa funzione o costante viene abilitata con l'istruzione Option VBASupport 1 posizionata prima del codice eseguibile del programma all'interno del modulo.


Sintassi:

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

Valore restituito:

Stringa

Parametri:

expression: obbligatoria. L'espressione numerica da formattare.

numDigitsAfterDecimal: facoltativo. Valore numerico che specifica il numero di cifre da visualizzare dopo la virgola decimale. Se omesso, il valore predefinito è -1, indicante che devono essere utilizzate le impostazioni locali predefinite dell'interfaccia utente.

includeLeadingDigit: facoltativo. Valore di enumerazione vbTriState, che specifica se, per i valori frazionali, deve comparire uno zero iniziale.

useParensForNegativeNumbers: facoltativo. Valore di enumerazione vbTriState che specifica se i numeri negativi debbano essere racchiusi tra parentesi.

groupDigits: facoltativo. Valore di enumerazione vbTriState che specifica il numero debba essere raggruppato (in migliaia, ecc.), utilizzando il delimitatore di gruppo specificato nelle impostazioni regionali del sistema.

Codici di errore:

13 Tipi di dati non corrispondenti

Esempio:

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