Strings.FormatCurrency, méthode

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

Espace de noms : Microsoft.VisualBasic
Assembly : Microsoft.VisualBasic (dans microsoft.visualbasic.dll)

Syntaxe

'Déclaration
Public Shared Function FormatCurrency ( _
    Expression As Object, _
    <OptionalAttribute> Optional NumDigitsAfterDecimal As Integer = -1, _
    <OptionalAttribute> Optional IncludeLeadingDigit As TriState = TriState.UseDefault, _
    <OptionalAttribute> Optional UseParensForNegativeNumbers As TriState = TriState.UseDefault, _
    <OptionalAttribute> Optional GroupDigits As TriState = TriState.UseDefault _
) As String
'Utilisation
Dim Expression As Object
Dim NumDigitsAfterDecimal As Integer
Dim IncludeLeadingDigit As TriState
Dim UseParensForNegativeNumbers As TriState
Dim GroupDigits As TriState
Dim returnValue As String

returnValue = Strings.FormatCurrency(Expression, NumDigitsAfterDecimal, IncludeLeadingDigit, UseParensForNegativeNumbers, GroupDigits)

public static string FormatCurrency (
    Object Expression,
    [OptionalAttribute] int NumDigitsAfterDecimal,
    [OptionalAttribute] TriState IncludeLeadingDigit,
    [OptionalAttribute] TriState UseParensForNegativeNumbers,
    [OptionalAttribute] TriState GroupDigits
)

public:
static String^ FormatCurrency (
    Object^ Expression, 
    [OptionalAttribute] int NumDigitsAfterDecimal, 
    [OptionalAttribute] TriState IncludeLeadingDigit, 
    [OptionalAttribute] TriState UseParensForNegativeNumbers, 
    [OptionalAttribute] TriState GroupDigits
)

public static String FormatCurrency (
    Object Expression, 
    /** @attribute OptionalAttribute() */ int NumDigitsAfterDecimal, 
    /** @attribute OptionalAttribute() */ TriState IncludeLeadingDigit, 
    /** @attribute OptionalAttribute() */ TriState UseParensForNegativeNumbers, 
    /** @attribute OptionalAttribute() */ TriState GroupDigits
)

public static function FormatCurrency (
    Expression : Object, 
    NumDigitsAfterDecimal : int, 
    IncludeLeadingDigit : TriState, 
    UseParensForNegativeNumbers : TriState, 
    GroupDigits : TriState
) : String

Paramètres

• Expression
  Obligatoire. Expression à mettre en forme.

• NumDigitsAfterDecimal
  Facultatif. 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
  Facultatif. Énumération TriState (3 états) qui indique si un zéro non significatif s'affiche pour les valeurs décimales. Consultez la section « Paramètres » pour obtenir les valeurs.

• UseParensForNegativeNumbers
  Facultatif. Énumération Tristate (3 états) qui indique si les valeurs négatives doivent être mises entre parenthèses. Consultez la section « Paramètres » pour obtenir les valeurs.

• GroupDigits
  Facultatif. Énumération Tristate (3 états) 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 la section « Paramètres » pour obtenir les valeurs.

Valeur de retour

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

Notes

Pour plus d'informations, consultez la rubrique Visual Basic FormatCurrency, fonction (Visual Basic).

Lorsqu'un ou plusieurs arguments facultatifs sont omis, les valeurs sont fournies par les paramètres régionaux correspondants de l'ordinateur.

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

Tous les paramètres sont issus des paramètres régionaux de l'application. Par défaut, il s'agit des paramètres régionaux définis dans le Panneau de configuration. Toutefois, ceux-ci peuvent être modifiés par programme à l'aide du .NET Framework, à l'exception du zéro non significatif, défini dans l'onglet Number.

Les arguments IncludeLeadingDigit, UseParensForNegativeNumbers et GroupDigits acceptent les valeurs d'énumération Tristate suivantes :

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

Exemple

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)

Plates-formes

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile pour Pocket PC, Windows Mobile pour Smartphone, Windows Server 2003, Windows XP Édition Media Center, Windows XP Professionnel Édition x64, Windows XP SP2, Windows XP Starter Edition

Le .NET Framework ne prend pas en charge toutes les versions de chaque plate-forme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise.

Informations de version

.NET Framework

Prise en charge dans : 2.0, 1.1, 1.0

.NET Compact Framework

Prise en charge dans : 2.0, 1.0

Voir aussi

Référence

Strings, classe
Membres Strings
Microsoft.VisualBasic, espace de noms
ArgumentException
InvalidCastException

Autres ressources

FormatCurrency, fonction (Visual Basic)
Liste des manipulations de chaînes
FormatDateTime, fonction (Visual Basic)
FormatNumber, fonction (Visual Basic)
FormatPercent, fonction (Visual Basic)
Tristate, énumération