Funzione FormatCurrency (Visual Basic)

Articolo
09/12/2008

Aggiornamento: novembre 2007

Restituisce un'espressione nel formato valore di valuta utilizzando il simbolo di valuta impostato nel Pannello di controllo del sistema.

Function FormatCurrency(
   ByVal Expression As Object,
   Optional ByVal NumDigitsAfterDecimal As Integer = -1,
   Optional ByVal IncludeLeadingDigit As TriState = TriState.UseDefault,
   Optional ByVal UseParensForNegativeNumbers As TriState = TriState.UseDefault,
   Optional ByVal GroupDigits As TriState = TriState.UseDefault
) As String

Parametri

Expression
Obbligatorio. Espressione alla quale verrà applicato il formato.
NumDigitsAfterDecimal
Facoltativo. Valore numerico che indica il numero di cifre decimali da visualizzare a destra del separatore. Il valore predefinito, -1, indica che sono in uso le impostazioni internazionali del sistema.
IncludeLeadingDigit
Facoltativo. Enumerazione TriState che indica se visualizzare o meno uno zero iniziale per i valori frazionari. I possibili valori sono indicati nella sezione "Impostazioni".
UseParensForNegativeNumbers
Facoltativo. Enumerazione TriState che indica se racchiudere o meno tra parentesi i valori negativi. I possibili valori sono indicati nella sezione "Impostazioni".
GroupDigits
Facoltativo. Enumerazione Tristate che indica se raggruppare o meno i numeri utilizzando il carattere di delimitazione di gruppo specificato nelle impostazioni internazionali. I possibili valori sono indicati nella sezione "Impostazioni".

Impostazioni

Gli argomenti IncludeLeadingDigit, UseParensForNegativeNumbers e GroupDigits accettano i valori di enumerazione TriState riportati di seguito.

Valore	Descrizione
TriState.True	True
TriState.False	False
TriState.UseDefault	Le impostazioni internazionali del sistema.

Eccezioni

Tipo di eccezione	Numero di errore	Condizione
ArgumentException	5	Il numero di cifre dopo il separatore decimale è maggiore di 99.
InvalidCastException	13	Il tipo non è numerico.

Se si esegue l'aggiornamento delle applicazioni Visual Basic 6.0 che utilizzano la gestione degli errori non strutturata, vedere la colonna "Numero di errore". È possibile confrontare il numero di errore con la Proprietà Number (oggetto Err). Se possibile, tuttavia, si consiglia di sostituire il controllo dell'errore con la procedura illustrata nella sezione Cenni preliminari sulla gestione strutturata delle eccezioni per Visual Basic.

Note

Gli eventuali argomenti facoltativi omessi verranno sostituiti dai corrispondenti valori delle impostazioni internazionali del sistema.

La posizione del simbolo di valuta relativo al valore di valuta dipende dalle impostazioni internazionali del sistema.

Nota:
Tutte le informazioni sulle impostazioni dipendono dalle impostazioni internazionali dell'applicazione, stabilite mediante la scelta nel Pannello di controllo. Tali informazioni possono essere modificate a livello di codice utilizzando .NET Framework, ad eccezione dello zero iniziale che dipende dalla scheda Number.

Esempio

Nell'esempio riportato di seguito viene illustrato l'utilizzo della funzione FormatCurrency.

Dim TestDebt As Double = -4456.43
Dim TestString As String
' Returns "($4,456.43)".
TestString = FormatCurrency(TestDebt, , , TriState.True, TriState.True)