GlideCurrencyFormatter - スコープ指定

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：7分

    • GlideCurrencyFormatter API は、FX 通貨文字列をフォーマットするメソッドを提供します。

    GlideCurrencyFormatter オブジェクトをインスタンス化するときは、このオブジェクトの出力結果の形式を定義します。一度設定すると、そのオブジェクトの GlideCurrencyFormatter.format() メソッドを呼び出すたびに同じ形式が使用されます。GlideCurrencyFormatter() メソッドと format() メソッドは、FX 通貨をフォーマットするために呼び出す必要がある 2 つのメソッドだけです。

    GlideCurrencyFormatter() API には、次のことを可能にするオプションのメソッドも用意されています。
    • setLocale() を使用して通貨のロケールを設定します。ロケールを設定すると、フォーマッターでは、通貨金額の端数を表すために小数点または小数点のどちらを使用するかなど、そのロケールに固有の書式設定が考慮されます。デフォルト:システムロケール
    • setMinFractionDigits() を使用して表示する小数点以下の最小桁数を設定します。含める小数点/小数点カンマの右側の最小桁数を定義します。デフォルトでは、渡されたすべての桁が表示されます。渡された金額の桁数が指定された最小値よりも少ない場合、結果には「0」が埋め込まれます。
    • setMaxFractionDigits() を使用して表示する小数点以下の最大桁数を設定します。含める小数点/小数点カンマの右側の最大桁数を定義します。デフォルトでは、渡されたすべての桁が表示されます。渡された金額が指定された最大桁数より大きい場合、小数部の最大桁数への丸め処理中に、追加の桁数が切り捨てられます。丸めは、右端の最も近い桁に実行されます。たとえば、小数部の最大桁数が 2 に設定され、渡された通貨値が 123.456 の場合、書式設定された値は 123.46 です。通貨値が 23.122 の場合、書式設定された値は 23.12 です。最大値が最小値より小さい値に設定されている場合は、最小値が使用されます。

    このクラスの実行は、 sn_currency 名前空間にあります。

    GlideCurrencyFormatter - GlideCurrencyFormatter(文字列 formatString)

    GlideCurrencyFormatter オブジェクトをインスタンス化し、FX 通貨の書式設定に使用する書式文字列を定義します。

    このメソッドは、実際の文字列形式を実行しません。通貨を書式設定するには、 GlideCurrencyFormatter.format() メソッドを呼び出す必要があります。

    表 : 1. パラメーター
    名前 タイプ 説明
    formatString 文字列 オプション。フォーマッターに渡される通貨の書式設定に使用する文字列の書式設定。

    有効な値：

    • %s: format() 呼び出しで指定された国コードに関連付けられた通貨記号に置き換えられます。
    • %v:通貨金額に置き換えられます (例:123.45)。
    • %c: format() 呼び出しで指定された ISO 通貨コード (USD や EUR など) に置き換えられます。
    • %l:渡された値に置き換えられます。書式設定は実行されません。
    • %p:パーセント記号 (%) に置き換えられます。

    たとえば、書式設定文字列が「%s%v%c」で、書式設定する値が米ドルで 123.45 の場合、返される書式設定された文字列は 123.45 USD です。書式設定文字列が「%s%l%c」で、書式設定する値の文字列がユーロで「56M」の場合、返される書式設定された文字列は €56M EUR です。

    注:
    このオブジェクトで format() メソッドが呼び出されるたびに、同じ形式の文字列が使用されます。

    この例では、メソッドを呼び出す方法を示します。

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

    GlideCurrencyFormatter - format(文字列値, 文字列 currencyCode)

    指定された通貨コードを使用して、指定された通貨値を書式設定します。

    結果として得られる通貨の形式は、GlideCurrencyFormatter オブジェクトが最初にインスタンス化されたときに渡された値にも依存します。

    表 : 2. パラメーター
    名前 タイプ 説明
    value 文字列 書式設定する通貨金額。金額には、端数を示す小数点のみを含めることができます。カンマはサポートされていません。

    有効な値:123.45 または 2436.23

    無効な値:123、45 または 2,134.56
    currencyCode 文字列 通貨の書式設定時に使用する 3 文字の ISO 通貨コード。
    表 : 3. 返される内容
    タイプ 説明
    文字列 書式設定された通貨値。

    この例では、メソッドを呼び出す方法を示します。

    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));

    出力：

    Formatted currency: $123,456.12USD

    GlideCurrencyFormatter - setLocale(文字列言語, 文字列国)

    通貨フォーマッターのデフォルトの言語と国 (ロケールを構成する) を設定します。

    GlideCurrencyFormatter.format() メソッドを呼び出す前にこのメソッドを呼び出しない場合、ロケールはデフォルトで現在のセッションロケールに設定されます。

    表 : 4. パラメーター
    名前 タイプ 説明
    言語 文字列 en、sp、fr などの 2 文字の ISO 639 言語コード。
    country 文字列 2 文字の ISO 3166 国コード (US、ES、FR など)。
    表 : 5. 返される内容
    タイプ 説明
    なし

    この例は、通貨フォーマッターをフランスに設定する方法を示しています。

    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));

    出力:

    Formatted currency: €123 456,12EUR

    GlideCurrencyFormatter - setMaxFractionDigits(数値 maxFractionDigits)

    返す小数点/小数点カンマの右側の最大桁数を設定します。

    表 : 6. パラメーター
    名前 タイプ 説明
    maxFractionDigit 番号 返す小数部の最大桁数。この値が minFractionDigits 値よりも小さい値に設定されている場合は、 minFractionDigitsによって上書きされます。
    表 : 7. 返される内容
    タイプ 説明
    なし

    この例では、メソッドを呼び出す方法を示します。

    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));

    出力：

    Formatted currency: $123,456.12USD

    GlideCurrencyFormatter - setMinFractionDigits(数値 minFractionDigits)

    返す小数部の最小桁数 (小数点/小数点のカンマの右) を設定します。

    表 : 8. パラメーター
    名前 タイプ 説明
    minFractionDigit 番号 返す小数部の最小桁数。
    表 : 9. 返される内容
    タイプ 説明
    なし 
    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));

    出力:

    Formatted currency: $123,456.120USD