format メソッド

このメソッドは、指定した書式（またはタイプ）とオプションを使用して指定した値を書式設定し、文字列として返します。このメソッドを使用するには、wijmo.input.IFormatValidateLib.format ではなく、$.wijinputcore.format を使用します。正しい使い方については、下記の例を参照してください。

wijinput ウィジェットは内部で同じ書式設定ライブラリを使用します。使用される書式設定のロジックは値型によって異なります。有効な型は以下のとおりです。

JavaScript Date
JavaScript String
JavaScript Number

Date

日付値の場合、書式設定ライブラリは wijinputdate のロジックを使用します。
formatOrType パラメーターは文字列値です。有効な wijinputdate dateFormat 値を指定できます。
options パラメーターには IDateOptions オブジェクトを指定するか、null にします。

String

文字列値の場合、書式設定ライブラリは wijinputmask のロジックを使用します。
formatOrType パラメーターは文字列値です。有効な wijinputmask maskFormat 値を指定できますが、正規表現の maskFormat 値は無効です。
options パラメーターには IMaskOptions オブジェクトを指定するか、null にします。

Number

数値の場合、書式設定ライブラリは wijinputnumber のロジックを使用します。
formatOrType パラメーターは文字列値です。以下のいずれかの値を指定できます。

currency
numeric
percent

options パラメーターには INumberOptions オブジェクトを指定するか、null にします。

シンタックス

Javascript (Usage)
var instance; //タイプ：wijmo.input.IFormatValidateLib; var returnValue; // Type: string // パラメータ var value; //タイプ： any var formatOrType; //タイプ： string var options; //タイプ： any returnValue = instance.format(value, formatOrType, options);

Javascript (Usage)

var instance; //タイプ：wijmo.input.IFormatValidateLib;
var returnValue; // Type: string

// パラメータ
var value; //タイプ： any
var formatOrType; //タイプ： string
var options; //タイプ： any

returnValue = instance.format(value, formatOrType, options);

Javascript (Specification)
function format( value : any, formatOrType : string, options : any ) : string;

パラメータ

value: 書式設定する値。date、string、number のいずれかの型の値を指定できます。
formatOrType: 値に適用する書式設定。値型に応じて、このパラメーターには dateFormat 値または maskFormat 値を指定するか、number 型の場合は currency、numeric、percent のいずれかを指定します。
options: 値に適用するその他の書式設定オプション。値型に応じて、このパラメーターには IDateOptions、IMaskOptions、INumberOptions のいずれかのオブジェクトを指定できます。

戻り値の型

指定したパラメーターに従って書式設定された文字列値。

使用例

Javascript

$.wijinputcore.format(new Date(2013,8,12)); // "9/12/2013" を返します。 $.wijinputcore.format(new Date(2013,8,12), "yyyy/MM/dd"); // "2013/09/12" を返します。 $.wijinputcore.format(new Date(2013,8,12)，{culture: "ja-JP"}); // "2013/09/12" を返します。 $.wijinputcore.format(new Date(2013,8,12,23,22,33), "tt hh:mm:ss", {culture: "ja-JP"}); // "午後 11:22:33" を返します。 $.wijinputcore.format(new Date(2013,8,12,24,12,12), "HH:mm:ss", {midnightAs0: true}); // "00:12:12" を返します。 $.wijinputcore.format("1234567", "９９９-９９９９", {autoConvert: true}); // "１２３-４５６７" を返します。 $.wijinputcore.format("1234567", "９９９-９９９９", {autoConvert: false}); // " " を返します。 $.wijinputcore.format(12345); // "12345.00" を返します。 $.wijinputcore.format(12345, "numeric", {decimalPlaces:3}); // "12345.000" を返します。 $.wijinputcore.format(12345, "percent"); // "12345.00 %" を返します。 $.wijinputcore.format(12345, "currency"); // "$12345.00" を返します。 $.wijinputcore.format(12345, "currency", {culture: "ja-JP"}); // "¥12345.00" を返します。 $.wijinputcore.format(12345, "numeric", {positivePrefix: "+", negativePrefix:"-"}); // "+12345.00" を返します。

Date

String

Number

パラメータ

戻り値の型

関連トピック

参照