リサイズはクリックかドラッグ

キーワードによる書式設定

このセクションでは、キーワードによる書式設定について説明します。

概要

数値コントロールでは、入力書式および表示書式をキーワード文字列にて設定することができます。キーワード文字列は、１つあるいは複数のキーワードの組み合わせで構成された文字列です。キーワードを使用して書式設定を行うと、コントロールはその内容に基づいてフィールドを自動的に作成します。

キーワードは文字列として次の順番で定義します。

パターン文字列, 正値の接頭辞文字列, 正値の接尾辞文字列, 負値の接頭辞文字列, 負値の接尾辞文字列

入力書式を設定するには、XAML 上では FieldSet プロパティを使用して、コード上では FieldSet プロパティが参照する NumberFieldSet オブジェクトの SetFields メソッドのオーバーロードの１つを使用してキーワード文字列を指定します。入力書式に使用できるキーワードについては「入力書式のキーワード」を参照してください。

以下のサンプルコードは、キーワードを使用して入力書式を設定します。

コピー
// キーワードにて入力書式を設定します。 
GcNumber1.FieldSet.SetFields("####0.00,,,-,");

// あるいは以下のように設定することができます。
GcNumber1.FieldSet.SetFields("####0.00","", "", "-", "");

また、表示書式を設定するには、XAML 上では DisplayFieldSet プロパティを使用して、コード上では FieldSet プロパティが参照する NumberFieldSet オブジェクトの SetFields メソッドのオーバーロードの１つ、および NumberDisplayFieldSetDisplayFields プロパティが参照する NumberDisplayFieldCollection の AddRange メソッドのオーバーロードの１つを使用してキーワード文字列を指定します。入力書式に使用できるキーワードについては「表示書式のキーワード」を参照してください。

以下のサンプルコードは、キーワードを使用して表示書式を設定します。

コピー
// 書式をクリアします。
GcNumber1.DisplayFieldSet.DisplayFields.Clear();

// キーワードにて表示書式を設定します。 
GcNumber1.DisplayFieldSet.DisplayFields.AddRange("[DBNum4]G,,円,-,円");
入力書式のキーワード

入力書式として使用可能なキーワードは以下のとおりです。

キーワード説明
#数値の桁を指定します。値が０の場合は何も表示されません。
0数値の桁を指定します。値が０の場合は０を表示します。
,カンマの挿入位置を指定します。少数部に指定することはできません。
.小数点の挿入位置を指定します。パターン文字列内に含められるのは１つだけです。
表示書式のキーワード

表示書式として使用可能なキーワードは以下のとおりです。

キーワード説明
#数値の桁を指定します。値が０の場合は何も表示されません。
0数値の桁を指定します。値が０の場合は０を表示します。
,整数部におけるカンマの挿入位置を指定します。少数部に指定することはできません。
.小数点の挿入位置を指定します。パターン文字列内に含められるのは１つだけです。
[DBNum1]G数値を漢数字で表示します。（例：一億二千三百四十五万六千七百八十九）
[DBNum2]G数字を漢数字（大字）で表示します。（例：壱億弐阡参百四拾伍萬六阡七百八拾九）
[DBNum3]G数字を漢数字と全角の数字を組み合わせて表示します。（例：１億２千３百４十５万６千７百８十９）
[DBNum4]G小数点以下の数字を漢数字を使って表示します。（例：〇.九分八厘七毛六糸五忽四微三纖二沙一塵）
[:][###:千]のように使用します。コロンの前に記載した桁数をコロンの後に記載した文字列に置き換えます。（例：1,234千円）
参照