System.MaskUtils.FormatMaskText

De RAD Studio API Documentation
Aller à : navigation, rechercher

Delphi

function FormatMaskText(const EditMask: string; const Value: string ): string;

C++

extern DELPHI_PACKAGE System::UnicodeString __fastcall FormatMaskText(const System::UnicodeString EditMask, const System::UnicodeString Value);

Propriétés

Type Visibilité  Source Unité  Parent
function public
System.MaskUtils.pas
System.MaskUtils.hpp
System.MaskUtils System.MaskUtils

Description

Renvoie une chaîne formatée à l'aide d'un masque d'édition.

Appelez FormatMaskText pour appliquer le masque spécifié par le paramètre EditMask au texte spécifié par le paramètre valeur. La chaîne masque consiste en trois champs séparés par un point-virgule. La première partie du masque est le masque lui-même. La seconde est le caractère qui détermine si les caractères du masque sont associés à des caractères dans le paramètre valeur ou insérés dans la chaîne valeur. La troisième partie du masque est le caractère utilisé pour représenter les caractères manquants dans le masque.

Voici les caractères spéciaux utilisés dans le premier champ du masque :

Caractère Signification dans le masque
! Si ce caractère apparaît dans le masque, les caractères facultatifs sont représentés dans la chaîne renvoyée comme des espaces de début. Si ce caractère n'est pas présent, les caractères facultatifs sont représentés dans la chaîne renvoyée comme des espaces de fin.
> Si un caractère > apparaît dans le masque, tous les caractères le suivant sont en majuscules jusqu'à la fin du masque ou jusqu'à occurrence du caractère <.
< Si un caractère < apparaît dans le masque, tous les caractères qui suivent sont en majuscules jusqu'à la fin du masque ou jusqu'à occurrence du caractère >.
<> Si ces deux caractères apparaissent dans un masque, la distinction minuscules/majuscules des caractères n'est pas vérifiée et les données sont formatées avec la distinction minuscules/majuscules présente dans le paramètre valeur.
\ Le caractère suivant ce caractère est un caractère littéral. Utilisez ce caractère pour définir comme littéraux tous les caractères spéciaux du masque.
L Ce caractère requiert un caractère alphabétique à cette position uniquement. Pour la France, il s'agit de A-Z et a-z. Pour la France, il s'agit de A-Z, a-z.
l Ce caractère n'autorise qu'un caractère alphabétique à cette position, mais ne l'exige pas.
A: Ce caractère exige un caractère alphanumérique à cette position. Pour la France, il s'agit de A-Z, a-z, 0-9.
a Ce caractère autorise un caractère alphanumérique à cette position, mais ne l'exige pas.
C Ce caractère exige un caractère arbitraire à cette position.
c Ce caractère autorise un caractère arbitraire à cette position, mais ne l'exige pas.
0 Ce caractère exige un caractère numérique à cette position.
9 Ce caractère autorise un caractère numérique à cette position, mais ne l'exige pas.
# Ce caractère autorise un caractère numérique ou le signe plus ou moins à cette position, mais ne l'exige pas.
: Ce caractère permet de séparer les heures, les minutes et les secondes. Si le caractère qui sépare ces éléments est différent dans le paramètre général de Windows, ce caractère lui est substitué dans la chaîne renvoyée.
/ Ce caractère permet de séparer les mois, les jours et les années dans les dates Si le caractère qui sépare ces éléments est différent dans le paramètre général de Windows, ce caractère lui est substitué dans la chaîne renvoyée.
; Ce caractère sépare les trois champs du masque.
_ Ce caractère insère automatiquement des espaces dans la chaîne renvoyée.

Tout caractère absent de ce tableau peut apparaître dans le masque comme caractère littéral. Ces caractères sont insérés automatiquement si le second champ du masque est 0 ou associé à des caractères dans le paramètre valeur si le second champ est une valeur différente. Les caractères spéciaux peuvent aussi apparaître comme caractères littéraux s'ils sont précédés d'une barre oblique inverse (\).

Le second champ du masque est un caractère unique indiquant si les caractères littéraux du masque sont inclus dans le paramètre valeur. Par exemple, le masque pour un numéro de téléphone avec indicatif régional pourra être la chaîne suivante :

(000)_000-0000;0;*

Le 0 dans le second champ indique que le paramètre Value devrait comprendre 10 chiffres, au lieu des 14 caractères qui forment la chaîne formatée finale.

Un 0 dans le second champ indique que les littéraux sont insérés dans la chaîne Value, tout autre caractère spécifie qu'ils doivent être inclus. Le caractère indiquant si les littéraux doivent être inclus peut être changé en modifiant la constante MaskNoSave déclarée dans l'unité MaskUtils.

Le troisième champ du masque est le caractère qui apparaît dans la chaîne renvoyée pour les blancs (caractères n'apparaissant pas dans Value). Par défaut, c'est le même caractère que celui des espaces littéraux. Les deux caractères apparaissent dans la chaîne renvoyée.

Remarque :  Lorsque vous utilisez des jeux de caractères multi-octets, chaque caractère spécial du masque représente un octet. Pour spécifier des caractères sur deux octets en utilisant les spécificateurs L, l, A, a, C ou c, les caractères du masque doivent également être doublés. Par exemple, LL représente deux caractères alphabétique d'un octet ou un caractère de deux octets. Seuls les caractères littéraux d'un octets sont supportés.

Voir aussi