GlideCurrencyFormatter : inclus dans le champ d’application

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 4 minutes de lecture

    • 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 de 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 FX Currency.

    L’API GlideCurrencyFormatter() fournit également des méthodes facultatives qui vous permettent de :
    • 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 tous les formatages spécifiques à ces paramètres régionaux, par exemple si une virgule décimale ou une virgule décimale est utilisée pour désigner des fractions du montant de devise. Valeur par défaut : Paramètres régionaux du système
    • Définissez le nombre minimum de chiffres fractionnaires à afficher à l’aide de setMinFractionDigits(). Définit le nombre minimal de chiffres à droite de la virgule/de la virgule décimale à inclure. Par défaut, tous les chiffres transmis sont affichés. Si le montant transmis a 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/de la virgule décimale à inclure. Par défaut, tous les chiffres transmis sont affichés. Si le montant transmis a un nombre de chiffres supérieur au nombre maximum spécifié, les chiffres supplémentaires sont tronqués pendant le processus d’arrondi au nombre de chiffres de fraction maximum. L’arrondi est effectué au chiffre le plus à droite le plus proche. Par exemple, si le chiffre de fraction maximal est défini sur 2 et que la valeur de la devise transmise est 123,456, la valeur formatée est 123,46. Si la valeur de devise est 23.122, la valeur formatée est 23.12. Si la valeur maximale est définie sur une valeur inférieure à la valeur minimale, la valeur minimale est utilisée.

    Cette classe s’exécute dans l’espace de noms sn_currency .

    Champ d’application défini 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.

    Tableau 1. Paramètres
    Nom Type Description
    formatString (chaîne de format) Chaîne Facultatif. Chaîne de format à utiliser pour formater toute devise transmise au formateur.

    Valeurs valides :

    • %s : Remplacé par le symbole de devise associé au code du pays spécifié dans l’appel format().
    • %v : remplacé par le montant de la devise, par exemple 123,45.
    • %c : Remplacé par le code de devise ISO spécifié dans l’appel format(), tel que USD ou EUR.
    • %l : remplacé par la valeur transmise, aucun formatage n’est effectué.
    • %p : Remplacé par le signe de pourcentage (%).

    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 123,45 USD. Si la chaîne de format est '%s%l%c’et que la chaîne de valeur à formater est '56M' en euros, la chaîne formatée renvoyée est 56M € EUR.

    Remarque :
    La même chaîne de format est utilisée à chaque fois que la méthode format() est appelée sur cet objet.

    Exemple

    var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);

    GlideCurrencyFormatter inclus dans le champ d’application : format(String value, String currencyCode)

    Formate une valeur de devise spécifiée à l’aide du code de devise spécifié.

    Le format résultant de la devise dépend également des valeurs transmises lors de l’instanciation initiale de l’objet GlideCurrencyFormatter.

    Tableau 2. Paramètres
    Nom Type Description
    valide Chaîne Montant de devise au format. Le montant ne peut contenir qu’une virgule décimale pour désigner le montant fractionnaire, les virgules ne sont pas prises en charge.

    Valeurs valides : 123,45 ou 2436,23

    Valeurs non valides 123,45 or 2,134.56
    currencyCode Chaîne Code de devise ISO à trois lettres à utiliser lors du formatage de la devise.
    Tableau 3. Renvoie
    Type Description
    Chaîne Valeur de devise formatée.

    Exemple

    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 inclus dans le champ d’application : 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 par défaut les paramètres régionaux de la session actuelle.

    Tableau 4. Paramètres
    Nom Type Description
    langue Chaîne Code de langue ISO 639 à deux lettres, tel que en, sp et fr.
    pays Chaîne Code pays ISO 3166 à deux lettres, par exemple US, ES et FR.
    Tableau 5. Renvoie
    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 inclus dans le périmètre : setMaxFractionDigits(Nombre maxFractionDigits)

    Définit le nombre maximal de chiffres à droite de la virgule/virgule décimale à renvoyer.

    Tableau 6. Paramètres
    Nom Type Description
    maxFractionDigits Numéro Nombre maximal de chiffres de fraction à renvoyer. Si cette valeur est définie sur une valeur inférieure à la minFractionDigits valeur, elle est remplacée par minFractionDigits.
    Tableau 7. Renvoie
    Type Description
    nul

    Exemple

    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 inclus dans le périmètre : setMinFractionDigits(Number minFractionDigits)

    Définit le nombre minimal de chiffres de fraction (à droite de la virgule/de la virgule décimale) à renvoyer.

    Tableau 8. Paramètres
    Nom Type Description
    minFractionDigits Numéro Nombre minimum de chiffres de fraction à renvoyer.
    Tableau 9. Renvoie
    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