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

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

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

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

パラメータ

value

使用する書式設定のロジックは、ここで設定した値型に基づいて決定されます。

有効な型は以下のとおりです。

• JavaScript date。例: new Date(2013,8,12)
• JavaScript string。例: "1234567"
• JavaScript number。例: 12345

値型が date の場合、書式設定ライブラリは wijinputdate のロジックを使用します。

値型が string の場合、書式設定ライブラリは wijinputmask のロジックを使用します。

値型が number の場合、書式設定ライブラリは wijinputnumber のロジックを使用します。

formatOrType

wininputdate

wijinputdate の場合、formatOrType パラメーターは、有効な dateFormat オブジェクトを含む文字列値です。

wijinputmask

wijinputmask の場合、formatOrType パラメーターは、有効な maskFormat オブジェクトを含む文字列値です。正規表現マスク書式は無効です。

wijinputnumber

wijinputnumber の場合、formatOrType パラメーターは、有効な型の値を含む文字列値です。

options

wininputdate

wininputdate の場合、options パラメーターは、5 つのプロパティまたは null を含むオブジェクトです。

• amDesignator は、AM（午前）の時刻を表す文字列指定子を決定します。
• culture は、書式設定ライブラリで使用するカルチャを示します。
• hour12As0 は、コントロールに入力できる時の範囲を決定するブール値です。
• midnightAs0 は、午前 0 時を 24:00 と表現するかどうかを決定するブール値です。
• pmDesignator は、PM（午後）の時刻を表す文字列指定子を決定します。

これらのオプションの詳細については、「InputDate」を参照してください。

wijinputmask

wijinputmask の場合、options パラメーターは、2 つのプロパティを含むオブジェクトです。

• autoConvert は、書式設定に従って値を適切な書式に自動的に変換するかどうかを示します。
• culture は、書式設定ライブラリで使用するカルチャを示します。

これらのオプションの詳細については、「InputMask」を参照してください。

wijinputnumber

wijinputnumber の場合、options パラメーターは、8 つのプロパティを含むオブジェクトです。

• currencySymbol は、数値タイプが通貨のときの通貨記号を決定します。デフォルト値はカルチャに従います。
• culture は、書式設定ライブラリで使用するカルチャを示します。
• decimalPlaces は、表示する小数点以下の桁数を示します。
• negativePrefix は、負の値に使用する接頭辞文字列を決定します。デフォルト値はカルチャと数値タイプに従います。
• negativeSuffix は、負の値に使用する接尾辞文字列を決定します。デフォルト値はカルチャと数値タイプに従います。
• positivePrefix は、正の値に使用する接頭辞文字列を決定します。デフォルト値はカルチャと数値タイプに従います。
• positiveSuffix は、正の値に使用する接尾辞文字列を決定します。デフォルト値はカルチャと数値タイプに従います。
• showGroup は、桁グループごとに桁グループ区切り文字を挿入するかどうかを示します（桁グループの桁数は選択したカルチャによって異なります）。

これらのオプションの詳細については、「InputNumber」を参照してください。

Wijmo 入力ウィジェットは内部で同じ書式設定ライブラリを使用します。

書式設定の詳細については、「書式設定関数ライブラリ」を参照してください。