Strings.FormatCurrency(Object, Int32, TriState, TriState, TriState) Méthode

  • Référence

Définition

Espace de noms:
Microsoft.VisualBasic
Assembly:
Microsoft.VisualBasic.Core.dll
Assembly:
Microsoft.VisualBasic.dll
Source:
Strings.vb
Source:
Strings.vb
Source:
Strings.vb

Retourne une expression sous forme de valeur monétaire utilisant le symbole monétaire défini dans le Panneau de configuration du système.

public static string FormatCurrency (object? Expression, int NumDigitsAfterDecimal = -1, Microsoft.VisualBasic.TriState IncludeLeadingDigit = Microsoft.VisualBasic.TriState.UseDefault, Microsoft.VisualBasic.TriState UseParensForNegativeNumbers = Microsoft.VisualBasic.TriState.UseDefault, Microsoft.VisualBasic.TriState GroupDigits = Microsoft.VisualBasic.TriState.UseDefault);
public static string FormatCurrency (object Expression, int NumDigitsAfterDecimal = -1, Microsoft.VisualBasic.TriState IncludeLeadingDigit = Microsoft.VisualBasic.TriState.UseDefault, Microsoft.VisualBasic.TriState UseParensForNegativeNumbers = Microsoft.VisualBasic.TriState.UseDefault, Microsoft.VisualBasic.TriState GroupDigits = Microsoft.VisualBasic.TriState.UseDefault);
static member FormatCurrency : obj * int * Microsoft.VisualBasic.TriState * Microsoft.VisualBasic.TriState * Microsoft.VisualBasic.TriState -> string
Public Function FormatCurrency (Expression As Object, Optional NumDigitsAfterDecimal As Integer = -1, Optional IncludeLeadingDigit As TriState = Microsoft.VisualBasic.TriState.UseDefault, Optional UseParensForNegativeNumbers As TriState = Microsoft.VisualBasic.TriState.UseDefault, Optional GroupDigits As TriState = Microsoft.VisualBasic.TriState.UseDefault) As String

Paramètres

Expression
Object

Obligatoire. Expression à mettre en forme.

NumDigitsAfterDecimal
Int32

Optionnel. Valeur numérique indiquant le nombre de décimales affichées. La valeur par défaut est -1, ce qui indique que les paramètres régionaux de l’ordinateur sont utilisés.

IncludeLeadingDigit
TriState

Optionnel. Énumération TriState qui indique si un zéro non significatif s'affiche pour les valeurs décimales. Consultez « Remarques » pour plus d'informations sur les valeurs.

UseParensForNegativeNumbers
TriState

Optionnel. Énumération TriState qui indique si les valeurs négatives doivent ou non être placées entre parenthèses. Consultez « Remarques » pour plus d'informations sur les valeurs.

GroupDigits
TriState

Optionnel. Énumération TriState qui indique si les nombres doivent ou non être regroupés en utilisant le délimiteur de groupe spécifié dans les paramètres régionaux de l'ordinateur. Consultez « Remarques » pour plus d'informations sur les valeurs.

Retours

String

Une expression sous forme de valeur monétaire utilisant le symbole monétaire défini dans le Panneau de configuration du système.

Exceptions

ArgumentException

Le nombre de chiffres après la virgule est supérieur à 99.

InvalidCastException

Le type n’est pas numérique.

Exemples

L'exemple ci-dessous illustre l'utilisation de la fonction FormatCurrency.

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

Remarques

Lorsqu’un ou plusieurs arguments facultatifs sont omis, les valeurs de paramètres régionaux correspondantes de l’ordinateur sont utilisées à la place.

La position du symbole monétaire par rapport à la valeur monétaire est déterminée par les paramètres régionaux du système.

Notes

Toutes les informations sur les paramètres proviennent des paramètres régionaux de l’application. Par défaut, il s’agira des paramètres régionaux définis dans le panneau de configuration. Toutefois, il peut être modifié par programmation à l’aide du .NET Framework, à l’exception de zéro non non significatif, qui provient de l’onglet Number .

Les IncludeLeadingDigitarguments , UseParensForNegativeNumberset GroupDigits prennent les valeurs d’énumération TriState suivantes.

Valeur Description
TriState.True True
TriState.False False
TriState.UseDefault Paramètres régionaux de l’ordinateur

S’applique à

Voir aussi