タイムスパンコントロールでは、専用のキーワードを設定することで書式を設定することができます。 フィールドオブジェクトによる書式設定のように柔軟なスタイル設定が不要な場合、入力および表示書式についてそれぞれ1度のメソッド実行だけで定義できるため、簡単な実装が可能です。

キーワードによる書式設定は、4.0J以前のタイムスパンコントロールで利用されていた方法と同様の方法です。

コードによる設定

入力書式を設定するには、Fields プロパティが参照する TimeSpanFieldCollection クラスのAddRange メソッドに、入力書式用のキーワードを使用した文字列を設定します。

表示書式を設定するには、DisplayFields プロパティが参照するTimeSpanDisplayFieldCollection クラスのAddRange メソッドに、表示書式用のキーワードを使用した文字列を設定します。

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

Pattern, Decimal Places, Decimal Point, Positive Prefix, Positive Suffix, Negative Prefix, Negative Suffix

' キーワードから書式を設定します。
GcTimeSpan1.Fields.AddRange("hh時間mm分ss秒,0,.,,,-,")
GcTimeSpan1.DisplayFields.AddRange("hh時間mm分ss秒,0,.,,,-,")

// キーワードから書式を設定します。
gcTimeSpan1.Fields.AddRange("hh時間mm分ss秒,0,.,,,-,");
gcTimeSpan1.DisplayFields.AddRange("hh時間mm分ss秒,0,.,,,-,");

なお、AddRange メソッドにより書式を設定する場合でも、自動的にフィールドオブジェクトに変換されているため、設定後に特定のフィールドスタイルを変更することが可能です。

次のサンプルコードは、キーワードにより設定したタイムスパン書式で特定のフィールドのスタイルを設定する例です。

' 入力書式フィールドのスタイルを設定します。
GcTimeSpan1.Fields(0).BackColor = Color.Bisque
GcTimeSpan1.Fields(1).ForeColor = Color.DarkGray
GcTimeSpan1.Fields(2).Font = New Font("Meiryo UI", 12)

' 表示書式フィールドのスタイルを設定します。
GcTimeSpan1.DisplayFields(0).Font = New Font("ＭＳ ゴシック", 15)
GcTimeSpan1.DisplayFields(1).BackColor = Color.Yellow
GcTimeSpan1.DisplayFields(2).ForeColor = Color.Gray

// 入力書式フィールドのスタイルを設定します。
gcTimeSpan1.Fields[0].BackColor = Color.Bisque;
gcTimeSpan1.Fields[1].ForeColor = Color.DarkGray;
gcTimeSpan1.Fields[2].Font = new Font("Meiryo UI", 12);

// 表示書式フィールドのスタイルを設定します。
gcTimeSpan1.DisplayFields[0].Font = new Font("ＭＳ ゴシック", 15);
gcTimeSpan1.DisplayFields[1].BackColor = Color.Yellow;
gcTimeSpan1.DisplayFields[2].ForeColor = Color.Gray;

デザイン画面での設定

デザイン画面では「入力書式の設定」「表示書式の設定」エディタを使用して容易な設定が可能です。これらのエディタは次のいずれかの方法で起動でき、 タイムスパンのキーワードを設定することで書式を作成します。

• プロパティページの「書式設定」 - 「入力フィールド」を選択し〈キーワードによる書式設定〉ボタンを押下
• コントロールのスマート タグから「入力書式の設定...」を選択

• プロパティページの「書式設定」 - 「表示フィールド」を選択し〈キーワードによる書式設定〉ボタンを押下
• コントロールのスマート タグから「表示書式の設定...」を選択

個々のフィールドのプロパティは設定できませんが、「時間」「分」「秒」などのリテラル文字を使用した書式が予めビルトイン書式として用意されているため、これらのリストから書式を選択するだけで簡単に書式を定義することが可能です。

「表示書式の設定」エディタ

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

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