FormatNumber [VBA]

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

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

Sintassi:

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

Valore restituito:

String

Parametri:

expression: richiesto. Un'espressione numerica da formattare. Se expression è una stringa, i separatori dei decimali e delle migliaia devono essere localizzati.

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.

vbTrue o -1: mostra uno zero iniziale.
vbFalse o 0: non mostra zero iniziali.
vbUseDefault o -2: usa le impostazioni locali dell'interfaccia utente. Quando omesso, è il valore predefinito.

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

vbTrue o -1: usa le parentesi per i numeri negativi.
vbFalse o 0: non mostra le parentesi.
vbUseDefault o -2: uguale a vbFalse. Quando omesso, è il valore predefinito.

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

vbTrue o -1: raggruppa le cifre.
vbFalse o 0: non raggruppa le cifre.
vbUseDefault o -2: uguale a vbFalse. Quando omesso, è il valore predefinito.

Codici di errore:

13 Tipi di dati non corrispondenti

Esempio:

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

Funzioni matematiche VBA