Contenu

# Fonction Format

Convertit une expression numérique en chaîne de caractères puis formate celle-ci en fonction du format spécifié.

### Syntaxe :

    Format(expression [, format As String]) As String

### Paramètres :

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

format : chaîne spécifiant le code de format du nombre. Si format est omis, la fonction Format fonctionne comme la fonction Str() de LibreOffice Basic.

### Type de renvoie :

Chaîne de texte.

## Descriptions de format

En BASIC, un code format peut être divisé en trois sections séparées par des points-virgules. La première partie définit le format des valeurs positives, la deuxième les valeurs négatives et la troisième le zéro. Si vous ne spécifiez qu'un seul code format, il s'applique à tous les nombres.

Vous pouvez définir les paramètres régionaux utilisés pour contrôler le formatage des nombres, des dates et des devises dans LibreOffice Basic dans LibreOffice - Préférences Outils - Options - Langues et locales - Général. Dans les codes au format Basic, le point décimal (.) est toujours utilisé comme espace réservé pour le séparateur décimal défini dans vos paramètres régionaux 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.

La liste suivante décrit les codes à utiliser pour formater une expression numérique :

Code | Description
--- | ---
0 | Si expression comporte un chiffre à la position 0 dans le code format, le chiffre est affiché, sinon un zéro est affiché. Si expression possède moins de chiffres que le nombre de zéros du code de format (de chaque côté de la décimale), les zéros à gauche et à droite apparaissent. Si expression possède plus de chiffres à gauche du séparateur de décimales que le nombre de zéros dans le code de format, les chiffres supplémentaires sont affichés sans formatage. Les décimales dans l'expression sont arrondies en fonction du nombre de zéros apparaissant après le séparateur de décimales dans le code de format.
# | Si expression contient un chiffre à la position de l'espace réservé # dans le code format, le chiffre est affiché, sinon rien n'est affiché à 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 le code de format que de chiffres dans l'expression. Seuls les chiffres pertinents de l'expression sont affichés.
. (period) | Le substituant décimal détermine le nombre de décimales à gauche et à droite du séparateur de décimales. Si le code 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 fractionnels, utilisez 0 comme substituant pour le premier chiffre à gauche du séparateur de décimales. 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.
% | Multiplie l'expression par 100 et insère le signe de pourcentage (%) là où l'expression apparaît dans le code format.
E- E+ e- e+ | Si le code de format comporte au moins un substituant de chiffre (0 ou #) situé à droite du symbole E-, E+, e- ou e+, l'expression est formatée 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.
- + $ ( ) space | : Les signes plus (+), moins (-), dollar ($), espace, ou des parenthèses saisis directement dans le code 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 le code format. Les caractères du code 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 le code 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 (@, &, <, >, !).

## Formats prédéfinis

Vous pouvez aussi utiliser les formats numériques prédéfinis suivants. À l'exception de General Number, tous les codes 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.

Code | Description
--- | ---
"<" | Convertir expression en minuscules
">" | Convertir expression en majuscules.
"c" or "General Date" | Renvoie l' expression numérique au format de date court, éventuellement avec « H:MM:SS AM/PM ». Si expression est une chaîne, renvoie la chaîne.
"n" | Renvoie la minute de l'expression numérique, avec 1 ou 2 chiffres.
"nn" | Renvoie la minute de l'expression numérique avec deux chiffres.
"w" | Renvoie le jour de la semaine de l'expression numérique. 1 est dimanche et 7 est samedi.
"General Number" | Renvoie l'expression numérique avec 12 chiffres (0.############).
"Currency" | Renvoie l'expression numérique dans la devise des paramètres régionaux.
"Fixed" | Renvoie l'expression numérique avec 2 décimales (0,00).
"Standard" | Renvoie l'expression numérique avec des séparateurs de milliers et 2 décimales (@0,00).
"Percent" | Renvoie l'expression numérique sous forme de pourcentage (0,00 %).
"Scientific" | Renvoie l'expression numérique en notation scientifique (#.00E+00) ;
"Yes/No" | Renvoie « Oui » si l'expression numérique n'est pas égale à zéro, « Non » dans le cas contraire. « Oui » et « Non » sont localisés.
"True/False" | Renvoie « Vrai » si l'expression numérique n'est pas égale à zéro, « Faux » sinon. « Vrai » et « Faux » sont localisés.
"On/Off" | Renvoie « Activé » si l'expression numérique n'est pas égale à zéro, « Désactivé » dans le cas contraire. « Activé » et « Désactivé » sont localisés.
"Long Date" or "dddddd" | Renvoie l'expression numérique au format de date longue du système et dépend des paramètres régionaux.
"Medium Date" | Renvoie l'expression numérique au format de date JJ-MMM-AA et dépend des paramètres régionaux.
"Short Date" or "ddddd" | Renvoie l'expression numérique au format de date courte du système et dépend des paramètres régionaux.
"Long Time" or "ttttt" | Renvoie l'expression numérique au format d'heure long du système et dépend des paramètres régionaux ("H:MM:SS AM/PM").
"Medium Time" | Renvoie l'expression numérique au format d'heure du média système et dépend des paramètres régionaux (HH:MM AM/PM)
"Short Time" | Renvoie l'expression numérique au format d'heure court du système et dépend des paramètres régionaux (HH:MM).

### 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.
    msgbox Format("ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890", "<") ' renvoie abcdefghijklmnopqrstuvwxyz1234567890, chiffres non affectés.
    msgbox Format("abcdefghijklmnopqrstuvwxyz1234567890", ">") ' renvoie ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890, chiffres non affectés.
    msgBox Format(12345.6,"c") ' renvoie le nombre au format de date 18/10/33 14:24:00 en langue allemande.
    msgBox Format(12345.6,"Date générale") ' Identique à "c".
    msgbox format(12345.004,"n") ' renvoie 5
    msgbox format(12345.004,"nn") ' renvoie 05
    msgbox format(12345.6,"w") ' renvoie 4 (Mercredi).
    msgbox format(log(123),"General Number") ' renvoie 4,812184355372 en paramètre régional allemand.
    msgbox format(123456.7890,"Fixed") ' 123456.79
    msgbox format(123456.1234,"Fixed") ' 123456.12
    msgbox format(123456.7890,"Standard") '123,456.79
    msgbox format(123456.1234,"Standard") '123,456.12
    msgbox format(12.3456,"Percent") ' 1234.56%
    msgbox format(0.123456,"Percent") '12.35%
    msgbox format(123,"Oui/Non") ' renvoie "Oui" localisé
    msgbox format(0,"Oui/Non") ' renvoie "Non" localisé
    msgbox format(-1,"Vrai/Faux") ' renvoie "Vrai" localisé
    msgbox format(123,"Activé/Désactivé") ' renvoie "Activé" localisé
    msgbox format(45756.73,"Long Date") ' renvoie le mercredi 9 avril 2025 dans votre langue
    End Sub

Rubriques connexes

Codes de format numérique

Fonctions de chaîne