GlideCurrencyFormatter : délimité
L’API GlideCurrencyFormatter fournit des méthodes pour formater les chaînes de devises FX.
Lors de l’instanciation de l’objet GlideCurrencyFormatter, vous définissez le format des résultats de sortie pour cet objet. Une fois défini, le même format est utilisé chaque fois que vous appelez la méthode GlideCurrencyFormatter.format() de cet objet. Les méthodes GlideCurrencyFormatter() et format() sont les deux seules méthodes que vous devez appeler pour formater la devise FX.
- Définissez les paramètres régionaux de la devise à l’aide de setLocale(). En définissant les paramètres régionaux, le formateur prend en compte toute mise en forme spécifique à ces paramètres régionaux, par exemple si une virgule décimale ou une virgule décimale est utilisée pour indiquer les fractions du montant de la devise. Par défaut : paramètres régionaux du système
- Définissez le nombre minimal de chiffres fractionnaires à afficher à l’aide de setMinFractionDigits(). Définit le nombre minimum de chiffres à droite de la virgule décimale ou de la virgule décimale à inclure. Par défaut, tous les chiffres transmis sont affichés. Si le montant transféré comporte moins de chiffres que le minimum spécifié, le résultat est complété par « 0 ».
- Définissez le nombre maximal de chiffres fractionnaires à afficher à l’aide de setMaxFractionDigits(). Définit le nombre maximal de chiffres à droite de la virgule décimale ou de la virgule décimale à inclure. Par défaut, tous les chiffres transmis sont affichés. Si le montant transféré comporte un nombre de chiffres supérieur au maximum spécifié, les chiffres supplémentaires sont tronqués lors du processus d’arrondi au nombre de chiffres fractionnaires maximum. L’arrondi est arrondi au chiffre le plus à droite le plus proche. Par exemple, si la fraction de chiffre maximale est définie sur 2 et que la valeur de la devise transmise est 123,456, la valeur formatée est 123,46. Si la valeur de la devise est 23,122, la valeur formatée est 23,12. Si la valeur maximale est inférieure à la valeur minimale, la valeur minimale est utilisée.
Cette classe s’exécute dans l’espace de noms sn_currency .
GlideCurrencyFormatter : GlideCurrencyFormatter(String formatString)
Instancie un objet GlideCurrencyFormatter et définit la chaîne de format à utiliser pour formater la devise FX.
Cette méthode n’exécute pas le format de chaîne réel. Vous devez appeler la méthode GlideCurrencyFormatter.format() pour formater la devise.
| Nom | Type | Description |
|---|---|---|
| formatChaîne | Chaîne | Facultatif. Chaîne de format à utiliser pour formater toute devise transmise au formateur. Valeurs valides :
Par exemple, si la chaîne de format est « %s %v %c » et que la valeur à formater est 123,45 en dollars américains, la chaîne formatée renvoyée est de 123,45 USD. Si la chaîne de format est « %s %l %c » et que la chaîne de valeur à formater est « 56 millions » en euros, la chaîne formatée renvoyée est de 56 millions d’euros. Remarque : La même chaîne de format est utilisée chaque fois que la méthode format() est appelée sur cet objet. |
Cet exemple montre comment appeler la méthode.
var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
GlideCurrencyFormatter : format(valeur de chaîne, chaîne currencyCode)
Formate une valeur de devise spécifiée à l’aide du code de devise spécifié.
Le format de la devise qui en résulte dépend également des valeurs transmises lors de l’instanciation initiale de l’objet GlideCurrencyFormatter.
| Nom | Type | Description |
|---|---|---|
| valide | Chaîne | Montant de la devise au format. Le montant ne peut contenir qu’une décimale pour indiquer le montant fractionnaire, les virgules ne sont pas prises en charge. Valeurs valides : 123,45 ou 2436,23 Valeurs non valides : 123,45 ou 2 134,56 |
| currencyCode | Chaîne | Code de devise ISO à trois lettres à utiliser lors du formatage de la devise. |
| Type | Description |
|---|---|
| Chaîne | Valeur de la devise formatée. |
Cet exemple montre comment appeler la méthode.
var amount = '123456.123456789';
var currencyCode = 'USD';
var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
gs.info('Formatted currency: ' + exchangeValue.setMaxFractionDigits(2).format(amount, currencyCode));
Sortie :
Formatted currency: $123,456.12USD
GlideCurrencyFormatter : setLocale(String language, String country)
Définit la langue et le pays par défaut, qui constituent les paramètres régionaux, pour le formateur de devise.
Si vous n’appelez pas cette méthode avant d’appeler la méthode GlideCurrencyFormatter.format(), les paramètres régionaux sont définis par défaut sur les paramètres régionaux de la session en cours.
| Nom | Type | Description |
|---|---|---|
| language | Chaîne | Code de langue ISO 639 à deux lettres, tel que en, sp et fr. |
| pays | Chaîne | Code de pays ISO 3166 à deux lettres, tel que US, ES et FR. |
| Type | Description |
|---|---|
| nul |
Cet exemple montre comment définir le formateur de devise sur France.
var amount = '123456.123456789';
var currencyCode = 'EUR';
var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
exchangeValue.setLocale("fr", "FR"); // Language = fr Country = FR
gs.info('Formatted currency: ' + exchangeValue.setMaxFractionDigits(2).format(amount, currencyCode));
Sortie :
Formatted currency: €123 456,12EUR
GlideCurrencyFormatter : setMaxFractionDigits(Number maxFractionDigits)
Définit le nombre maximal de chiffres à droite de la virgule décimale à renvoyer.
| Nom | Type | Description |
|---|---|---|
| Nombre maxFractionDigits | Numéro | Nombre de chiffres fractionnaires maximum à renvoyer. Si cette valeur est inférieure à la minFractionDigits valeur, elle est remplacée par minFractionDigits. |
| Type | Description |
|---|---|
| nul |
Cet exemple montre comment appeler la méthode.
var amount = '123456.123456789';
var currencyCode = 'USD';
var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
gs.info('Formatted currency: ' + exchangeValue.setMaxFractionDigits(2).format(amount, currencyCode));
Sortie :
Formatted currency: $123,456.12USD
GlideCurrencyFormatter : setMinFractionDigits(Nombre minFractionDigits)
Définit le nombre minimal de chiffres fractionnaires (à droite de la virgule décimale/virgule) à renvoyer.
| Nom | Type | Description |
|---|---|---|
| Chiffres de fraction minFraction | Numéro | Nombre minimum de chiffres fractionnaires à renvoyer. |
| Type | Description |
|---|---|
| nul |
var amount = '123456.12';
var currencyCode = 'USD';
var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
gs.info('Formatted currency: ' + exchangeValue.setMinFractionDigits(3).format(amount, currencyCode));
Sortie :
Formatted currency: $123,456.120USD