タイムスパンコントロールでは書式設定により、入力および表示書式を自由に設定することができます。入力書式は、コントロールが入力フォーカスを受け取ったときの書式で、表示書式は入力フォーカスのないときの書式です。
入力書式の設定は、Fields プロパティによって行われ、フィールドとよばれる入力領域を構成する要素によって定義されます。また、表示書式は、DisplayFields プロパティによって行われ、Fields プロパティと同様フィールドによって定義します。 Fields プロパティおよび DisplayFields プロパティについては、「書式の設定」で詳しく解説します。

タイムスパンコントロールで入力可能な範囲の指定を指定するには、コントロールのプロパティを使用する方法と、タイムスパン検証コンポーネントを使用する方法があります。

コントロールのプロパティを使用

コントロールのMaxValue プロパティとMinValue プロパティを設定してコントロールに入力可能な日付範囲を指定することができます。

これらのプロパティを使用する場合、検証は入力中のリアルタイムに行われます。全てのフィールドの値が入力されると検証が行われ、範囲外の値の場合にはMaxMinBehavior プロパティの設定によって制御されます。 MaxMinBehavior プロパティに設定できる値は以下のとおりで、既定値はMaxMinBehavior.AdjustToMaxMin です。

MaxMinBehavior プロパティをMaxMinBehavior.CancelInput に設定した場合、範囲外の日付の最後の入力を行った時点でInvalidInput イベントが発生します。 InvalidInputイベント側では入力された値が範囲外であることを取得できるため、メッセージを出力するなどのカスタマイズが可能です。

以下のサンプルコードは、範囲外の値が入力されたとき、メッセージボックスを表示する例です。

Imports GrapeCity.Win.Editors

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
    ' 最大値と最小値を設定します。  
    GcTimeSpan1.MaxValue = TimeSpan.Parse("1.00:00:00")
    GcTimeSpan1.MinValue = TimeSpan.Parse("00:00:00")

    ' 範囲外の場合に値をどのように制御するかを設定します。  
    GcTimeSpan1.MaxMinBehavior = MaxMinBehavior.CancelInput
End Sub

Private Sub GcTimeSpan1_InvalidInput(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles GcTimeSpan1.InvalidInput
    Dim InvalidInputEventArgs As InvalidInputEventArgs = TryCast(e, InvalidInputEventArgs)
    If InvalidInputEventArgs Is Nothing Then
            Exit Sub    
        End If
    
        ' 値が範囲外の場合には、メッセージを表示します。  
    If InvalidInputEventArgs.ValueOutOfRange Then
            MessageBox.Show("範囲外の値です。")
    End If
End Sub

using GrapeCity.Win.Editors;

private void Form1_Load(object sender, EventArgs e)
{
    // 最大値と最小値を設定します。 
    gcTimeSpan1.MaxValue = TimeSpan.Parse("1.00:00:00");
    gcTimeSpan1.MinValue = TimeSpan.Parse("00:00:00");

    // 範囲外の場合に値をどのように制御するかを設定します。 
    gcTimeSpan1.MaxMinBehavior = MaxMinBehavior.CancelInput;
}

private void gcTimeSpan1_InvalidInput(object sender, EventArgs e)
{
    InvalidInputEventArgs invalidInputEventArgs = e as InvalidInputEventArgs;
    if (invalidInputEventArgs == null)
    {
        return;
    }

    // 値が範囲外の場合には、メッセージを表示します。 
    if (invalidInputEventArgs.ValueOutOfRange)
    {
        MessageBox.Show("範囲外の値です。");
    }
}

タイムスパン検証コンポーネントを使用

タイムスパン検証コンポーネントを使用して、タイムスパンコントロールに入力可能な値を指定することができます。 検証コンポーネントを利用した場合、範囲外の値ときに制御を行うだけではなく、エラーアイコンを表示したり背景色を変更したりと柔軟なエラー通知機能を利用することが可能です。

検証コンポーネントを利用して入力範囲の検証を行う場合には、以下のいずれかの設定を行う必要があります。

• タイムスパンコントロールのMaxValue、MinValue プロパティを既定値のままにする
• タイムスパンコントロールのMaxMinBehavior プロパティをMaxMinBehavior.Keep に設定する

この設定を行わない場合、タイムスパンコントロールの入力中に行う検証機能が動作し、検証コンポーネントによる検証が行われません。

タイムスパン検証コンポーネントを利用して入力可能な範囲を設定するには、GcTimeSpanValidator.InvalidRange クラスを使用し、GcTimeSpanValidator.InvalidRange クラスのMaxValue およびMinValue プロパティで、最大値および最小値を指定します。

タイムスパン検証コンポーネントを使用した範囲設定やエラー通知の詳細については「検証コンポーネント」を参照してください。

コントロールの入力をプラスの値かマイナスの値のいずれかのみを許可したい場合、ValueSign プロパティを設定します。

マイナスキーは値をプラスとマイナスを切り替えるスイッチのような動作を行います。(１回目のマイナスキー押下で値がマイナスに変化、２回目押下でプラスに変化) この動作は、タイムスパンコントロールに以下のショートカット機能が設定されていることで実現されています。

• キー：OemMinus に対して ショートカット動作の SwitchSign
• キー：Subtract に対して ショートカット動作の SwitchSign

この動作を、マイナスキーが押下された場合には値をマイナスに変更するだけの動作とさせることもできます。(１回目のマイナスキー押下で値がマイナスに変化、２回目押下でもマイナスのまま。プラスにしたい場合はプラスキーを押下する)
既定の動作から新しい動作に変更するためには、上記で挙げたふたつのショートカット機能を削除します。

' キー：OemMinusとSubtractに設定しているショートカット機能を削除します。
GcShortcut1.GetShortcuts(GcTimeSpan1).Remove(Keys.OemMinus)
GcShortcut1.GetShortcuts(GcTimeSpan1).Remove(Keys.Subtract)

// キー：OemMinusとSubtractに設定しているショートカット機能を削除します。
gcShortcut1.GetShortcuts(gcTimeSpan1).Remove(Keys.OemMinus);
gcShortcut1.GetShortcuts(gcTimeSpan1).Remove(Keys.Subtract);

Value プロパティを使えば、リテラル文字列とプロンプト文字列を除いたコントロールの基となる値をTimeSpan 型で取得または設定できます。

リテラル文字とプロンプト文字については「書式の設定」で解説しています。

クリップボードにリテラル文字を含まない値を渡すには、ClipContent プロパティとSelectedText プロパティを使用します。ClipContentプロパティで制御できるのは、SelectedTextプロパティの値のみなので、以下のプロパティの値をクリップボードに設定した場合は、ClipContentプロパティの設定は無効になります。なお、プロンプト文字列は、ClipContentプロパティの設定に関わらず常にクリップボードに渡されます。

次のサンプルコードは、ClipContentプロパティを使って、リテラル文字列を省いた文字列をクリップボードにコピーする方法を示します。

Imports GrapeCity.Win.Editors

' コントロールに値を設定して、クリップボードにコピーします。
GcTimeSpan1.Fields.Clear()
GcTimeSpan1.Fields.AddRange("hh時間mm分ss秒,0,.,,,-,")
GcTimeSpan1.Value = System.TimeSpan.Parse("12:21:00")
GcTimeSpan1.ClipContent = ClipContent.ExcludeLiterals
GcTimeSpan1.SelectionStart = 0
GcTimeSpan1.SelectionLength = GcTimeSpan1.Text.Length
Clipboard.SetDataObject(GcTimeSpan1.SelectedText)

' クリップボードのデータを取得して確認します。
Dim cbTimeSpan As IDataObject = Clipboard.GetDataObject()
Label1.Text = cbTimeSpan.GetData(DataFormats.Text)

using GrapeCity.Win.Editors;

// コントロールに値を設定して、クリップボードにコピーします。
gcTimeSpan1.Fields.Clear();
gcTimeSpan1.Fields.AddRange("hh時間mm分ss秒,0,.,,,-,");
gcTimeSpan1.Value = System.TimeSpan.Parse("12:21:00");
gcTimeSpan1.ClipContent = ClipContent.ExcludeLiterals;
gcTimeSpan1.SelectionStart = 0;
gcTimeSpan1.SelectionLength = gcTimeSpan1.Text.Length;
Clipboard.SetDataObject(gcTimeSpan1.SelectedText);

// クリップボードのデータを取得して確認します。
IDataObject cbData = Clipboard.GetDataObject();
label1.Text = cbData.GetData(DataFormats.Text).ToString();

AcceptsCrLf プロパティを使用してクリップボードへ改行を含む文字列をコピー、または貼り付けた場合の改行コードの扱いを設定できます。AcceptsCrLf プロパティは、CrLfMode 列挙体を使用して次の値を設定できます。

コントロールに文字列を入力するとTextChanging イベントが、TextChangedイベントの前（入力された文字列がTextプロパティに渡される前）に発生します。そのため、このイベント内で入力文字列をチェックすれば、Textプロパティの値に影響を与えることなく、入力を制御できます。