FormatNumber, fonction (Visual Basic)

  • Article

Mise à jour : novembre 2007

Retourne une expression sous forme de nombre.

Function FormatNumber(
   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

Paramètres

  • Expression
    Requis. Expression à formater.

  • 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. Constante Tristate (3 états) qui indique si un 0 non significatif s'affiche pour les valeurs décimales. Consultez « Settings » pour obtenir les valeurs.

  • UseParensForNegativeNumbers
    Facultatif. Constante Tristate (3 états) qui indique si les valeurs négatives doivent être mises entre parenthèses. Consultez « Settings » pour obtenir les valeurs.

  • GroupDigits
    Facultatif. Constante 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 « Settings » pour obtenir les valeurs.

Paramètres

Les arguments IncludeLeadingDigit, UseParensForNegativeNumbers et GroupDigits prennent les valeurs suivantes.

Constante

Description

TriState.True

True

TriState.False

False

TriState.UseDefault

Paramètres régionaux de l'ordinateur

Exceptions

Type d'exception

Numéro de l'erreur

Condition

InvalidCastException

13

Le type n'est pas numérique.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion non structurée des erreurs. (Vous pouvez comparer le numéro d'erreur par rapport à Number, propriété (objet Err).) Toutefois, lorsque cela est possible, vous devez envisager de remplacer un tel contrôle d'erreurs par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

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

Remarque :

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.

Exemple

Cet exemple illustre la fonction FormatNumber.

Dim TestNumber As Integer = 45600
' Returns "45,600.00".
Dim TestString As String = FormatNumber(TestNumber, 2, , , TriState.True)

Configuration requise

Espace de noms :Microsoft.VisualBasic

**Module :**Strings

**Assembly :**bibliothèque Visual Basic Runtime (dans Microsoft.VisualBasic.dll)

Voir aussi

Référence

Liste des manipulations de chaînes

FormatCurrency, fonction (Visual Basic)

FormatDateTime, fonction (Visual Basic)

FormatPercent, fonction (Visual Basic)

Tristate, énumération

InvalidCastException