Data.DB.TNumericField.DisplayFormat

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

property DisplayFormat: string read FDisplayFormat write SetDisplayFormat;

C++

__property System::UnicodeString DisplayFormat = {read=FDisplayFormat, write=SetDisplayFormat};

Propriétés

Type Visibilité  Source Unité  Parent
property published
Data.DB.pas
Data.DB.hpp
Data.DB TNumericField

Description

Détermine comment la valeur d'un champ numérique est formatée pour l'affichage dans un contrôle orienté données.

La propriété DisplayFormat permet de redéfinir le formatage automatique d'un champ à l'affichage.

Remarque :  DisplayFormat n'agit que sur l'affichage de la valeur du champ. Cette propriété n'affecte en rien la validité des chaînes affectées à un champ numérique en utilisant la propriété AsString.

La valeur de DisplayFormat est une chaîne codant le formatage de la donnée numérique en utilisant les spécificateurs énumérés dans le tableau suivant.

Spécificateur Signification
0 Emplacement d'un chiffre. Si la valeur en cours de formatage a un chiffre à la position où "0" apparaît dans la chaîne de formatage, alors ce chiffre est copié dans la chaîne de sortie. Sinon, "0" est stocké à cette position dans la chaîne de sortie.
# Emplacement d'un chiffre. Si la valeur en cours de formatage a un chiffre à la position où "#" apparaît dans la chaîne de formatage, alors ce chiffre est copié dans la chaîne de sortie. Sinon, rien n'est inclus à cette position dans la chaîne en sortie.
. Séparateur décimal. Le premier caractère point "." dans la chaîne de format détermine l'emplacement du séparateur décimal dans la valeur formatée ; les caractères '.' supplémentaires sont ignorés. Le caractère effectivement utilisé comme séparateur décimal dans la chaîne en sortie est déterminé par la variable globale DecimalSeparator. La valeur par défaut de DecimalSeparator est spécifiée dans le format du nombre de la section Paramètres régionaux du Panneau de configuration Windows.
, Séparateur des milliers. Si la chaîne de formatage contient au moins un caractère ",", la sortie aura des séparateurs des milliers insérés entre chaque groupe de trois chiffres situés à gauche de la virgule décimale. L'emplacement et le nombre de caractères "," dans la chaîne de formatage n'affecte pas la sortie, sauf pour indiquer que les séparateurs des milliers sont souhaités. Le caractère effectivement utilisé comme séparateur décimal dans la chaîne en sortie est déterminé par la variable globale ThousandSeparator. La valeur par défaut de ThousandSeparator est spécifiée dans le format du nombre de la section Paramètres régionaux du Panneau de configuration Windows.
E+ Notation scientifique. Si une des chaînes "E+", "E-", "e+" ou "e-" est contenue dans la chaîne de formatage, le nombre est formaté en utilisant la notation scientifique. Un groupe comprenant jusqu'à quatre caractères "0" peut suivre immédiatement le "E+", "E-", "e+" ou le "e-" afin de déterminer le nombre minimum de chiffres dans l'exposant. Les formats "E+" et "e+" affichera un signe plus en sortie pour les exposants positifs et un signe moins pour les exposants négatifs. Les formats "E-" et "e-" ont en sortie un caractère signé uniquement pour les exposants négatifs.
'xx'/"xx" Les caractères encadrés par des guillemets simples ou doubles sont renvoyés tels quels et n'affectent pas le formatage.
; Sépare les sections des nombres positifs, négatifs et nuls dans la chaîne de format.

Les emplacements du "0" le plus à gauche avant la virgule décimale et du "0" le plus à droite après la virgule décimale dans la chaîne de formatage déterminent le rang des chiffres qui sont toujours présents dans la chaîne de sortie.

Le nombre en cours de formatage est toujours arrondi à autant de chiffres décimaux qu'il y a d'emplacements de chiffres ("0" or "#") à la droite de la virgule décimale. Si cette dernière ne contient pas de séparateur décimal, la valeur formatée est arrondie au nombre entier le plus proche.

Si le nombre en cours de formatage a plus de chiffres à la gauche du séparateur décimal qu'il n'y a d'emplacements de chiffres à la gauche du caractère "." dans la chaîne de formatage, les chiffres supplémentaires sont sortis avant le premier emplacement de chiffre.

Le tableau suivant illustre l'effet des diverses chaînes de format.

DisplayFormat Valeur Résultat Commentaire
#.## 12.2 12.2 Sachez que les chiffres en excédent sur la gauche du séparateur décimal apparaissent toujours.
#.00 2.5 2.50 Remarquez le zéro supplémentaire : le champ indique systématiquement deux chiffres après la virgule.
00.## .006 00.01 Notez les zéros supplémentaires sur la droite du séparateur décimal et l'arrondi à deux décimales.

La chaîne de format peut contenir une, deux ou trois sections séparées par des points-virgules pour autoriser des formats différents pour les valeurs positives, négatives et nulles.

  • Une section : la chaîne de format s'applique à toutes les valeurs.
  • Deux sections : la première section s'applique aux valeurs positives et nulles et la deuxième aux valeurs négatives.
  • Trois sections : la première section s'applique aux valeurs positives, la deuxième aux valeurs négatives, et la troisième aux valeurs nulles.

Si la section pour les valeurs négatives ou celle pour les valeurs zéro est vide, c'est-à-dire, s'il n'existe rien entre les points-virgules délimitant la section, celle pour les valeurs positives est utilisées à la place.

Si la section pour les valeurs positives est vide ou si la chaîne de formatage entière est vide, la valeur est formatée en utilisant le formatage général à virgule flottante avec 15 chiffres significatifs. Ce type de format est également utilisé si la valeur dispose de plus de 18 chiffres à gauche du séparateur décimal et si la chaîne de format n'indique pas la notation scientifique.

Voir aussi