Fonction Format

Convertit un nombre en chaîne de caractères puis formate celle-ci en fonction du format spécifié.

Syntaxe :

Format (Number [, Format As String])

Valeur de retour :

Chaîne de caractères

Paramètres :

Number : expression numérique à convertir en chaîne de caractères formatée.

Format : chaîne de caractères spécifiant la description de format du nombre. Si Format est omis, la fonction Format fonctionne comme la fonction Str.

Descriptions de format

La liste suivante décrit les codes à utiliser pour formater un nombre :

0: Si Nombre possède un chiffre à la position du 0 dans la description de format, ce chiffre s'affiche. Dans le cas contraire, un zéro s'affiche.

Si l'expression numérique possède moins de chiffres que le nombre de zéros de la description de format (de chaque côté de la décimale), les zéros à gauche et à droite apparaissent. Si le nombre possède plus de chiffres à gauche du séparateur de décimales que le nombre de zéros dans la description de format, les chiffres supplémentaires sont affichés sans formatage.

Les décimales du nombre sont arrondies en fonction du nombre de zéros apparaissant après le séparateur de décimales dans la description de format.

#: Si Nombre possède un chiffre à la position du substituant # dans la description de format, ce chiffre s'affiche. Dans le cas contraire, rien ne s'affiche à cette position.

Ce symbole a la même fonction que le 0, à l'exception du fait que les zéros à gauche ou à droite ne sont pas affichés s'il y a plus de caractères # dans la description de format que de chiffres dans le nombre. Seuls les chiffres pertinents du nombre sont affichés.

.: Le substituant décimal détermine le nombre de décimales à gauche et à droite du séparateur de décimales.

Si la description de format ne contient que des substituants # à gauche de ce symbole, les nombres inférieurs à 1 débutent par un séparateur de décimales. Pour toujours afficher un zéro à gauche des nombres inférieur à 1, utilisez 0 comme substituant pour le premier chiffre à gauche du séparateur de décimales.

% : multiplie le nombre par 100 et insère le signe pourcentage (%) à l'endroit où apparaît le nombre dans la description de format.

E- E+ e- e+ : Si la description de format comporte au moins un substituant de chiffre (0 ou #) situé à droite du symbole E-, E+, e- ou e+, le nombre est formaté au format scientifique ou exponentiel. La lettre E ou e est insérée entre le nombre et l'exposant. Le nombre de substituants des chiffres situés à droite du symbole détermine le nombre de chiffres contenus dans l'exposant.

Si l'exposant a une valeur négative, un signe moins s'affiche entre le symbole E-, E+, e-, e+ et la valeur de l'exposant. Si l'exposant a une valeur positive, le signe plus ne s'affiche qu'entre le symbole E+ ou e+ et la valeur de l'exposant.

Le séparateur de milliers est affiché si la description de format comporte un séparateur compris entre des substituants de chiffres (0 ou #).

L'utilisation du point comme séparateur de décimales et de milliers dépend des paramètres régionaux. Lorsque vous saisissez un nombre directement en code source Basic, utilisez toujours un point comme séparateur de décimales. Le caractère utilisé comme séparateur de décimales dépend du format numérique des paramètres de votre système.

- + $ ( ) espace : Les signes plus (+), moins (-), dollar ($), espace, ou des parenthèses saisis directement dans la description de format sont affichés sous forme de caractères littéraux.

Pour afficher des caractères autres que ceux listés ici, vous devez les faire précéder d'une barre oblique inverse (\) ou les saisir entre guillemets (" ").

\ : La barre oblique inverse affiche le caractère suivant dans la description de format.

Les caractères de la description de format ayant une signification spéciale ne peuvent être affichés en tant que caractères littéraux que s'ils sont précédés d'une barre oblique inverse. La barre oblique inverse ne s'affiche pas, sauf si vous saisissez une double barre oblique inverse (\\) dans la description de format.

Les caractères devant être précédés par une barre oblique inverse dans la description de format pour s'afficher en tant que caractères littéraux sont les caractères de formatage de date et d'heure (a, c, d, h, m, n, p, q, s, t, w, y, /, :), les caractères de formatage numérique (#, 0, %, E, e, virgule, point) et les caractères de formatage de chaînes de caractères (@, &, <, >, !).

Vous pouvez aussi utiliser les formats numériques prédéfinis suivants. À l'exception de "Nombre standard", toutes les descriptions de format prédéfinies renvoient les nombres en tant que nombres décimaux à deux décimales.

Si vous utilisez des formats prédéfinis, le nom du format doit être saisi entre guillemets.

Format prédéfini

General Number : les nombres sont affichés tels qu'ils ont été saisis.

Currency : insère le caractère dollar avant le nombre et place les nombres négatifs entre parenthèses.

Fixed : affiche au moins un chiffre avant le séparateur de décimales.

Standard : affiche les nombres avec un séparateur de milliers.

Percent : multiplie le nombre par 100 et ajoute le signe pourcentage au nombre.

Scientific : affiche les nombres au format scientifique (par exemple, 1.00E+03 pour 1000).

Une description de format peut être divisée en trois sections séparées par des points-virgules. La première partie définit le format des valeurs positives, la seconde le format des valeurs négatives et la troisième le format des valeurs nulles. Si vous ne spécifiez qu'une description de format, celle-ci s'applique à tous les nombres.

Vous pouvez définir le paramètre local utilisé pour contrôler le formatage des nombres, des dates et monétaire dans LibreOffice Basic dans - Paramètres linguistiques - Langues. Dans les codes de format Basic, le point décimal (.) est toujours utilisé comme substituant pour le séparateur décimal défini dans votre paramètre local et sera remplacé par le caractère correspondant.

Cela s'applique également aux paramètres de l'environnement linguistique relatifs aux formats de date, d'heure et de monnaie. La description de format Basic est interprétée et affichée en fonction des paramètres de l'environnement linguistique.

Codes d'erreur :

5 appel de procédure incorrect

Exemple :

Sub ExampleFormat

    MsgBox Format(6328.2, "##,##0.00")

    ' utilisez toujours un point comme séparateur de décimales lorsque vous saisissez des nombres directement dans le code source Basic.

    ' affiche par exemple 6,328.20 dans un environnement linguistique anglais et 6.328,20 dans un environnement linguistique allemand.

End Sub