BeforeSpin イベント

スピンボタンによって値が変更される前に発生します。

シンタックス

Visual Basic

'宣言
 
Public Event BeforeSpin As BeforeSpinEventHandler

C#

public event BeforeSpinEventHandler BeforeSpin

イベント データ

イベント ハンドラが、このイベントに関連するデータを含む、BeforeSpinEventArgs 型の引数を受け取りました。次の BeforeSpinEventArgs プロパティには、このイベントの固有の情報が記載されます。

プロパティ	解説
Cancel System.ComponentModel.CancelEventArgsから継承されます。
CurrentValue	オブジェクトの現在の値を返します。
NewDate	スクロール先の日付を返します。
SpinDirection	押されたスピンボタンの方向を返します。

解説

キーボードとスピン ボタンのいずれを使用するかにかかわらず、スピンの結果として Value が変更しようとするときに、BeforeSpinイベントが呼び出されます。BeforeSpinEventArgs は現在の Value、新しい値、および押されたスピンボタンの BeforeSpinEventArgs.SpinDirection を提供します。System.ComponentModel.CancelEventArgs.Cancel プロパティを True に設定することで変更しないようにすることができます。

使用例

NOTE: This example requires that the control's SpinButtonsVisible property be set to true, like so:
Me.ultraCalendarCombo1.SpinButtonsVisible = True

Visual Basic

Private Sub ultraCalendarCombo1_BeforeSpin(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinSchedule.BeforeSpinEventArgs) Handles ultraCalendarCombo1.BeforeSpin

       '	Use the BeforeSpinEventArgs' CurrentValue property
       '	to determine the control's current value
       If (Not e.CurrentValue Is Nothing) Then
           Dim dateVal As DateTime = e.CurrentValue
           Dim info As String = String.Empty

           '	Use the AfterSpinEventArgs' SpinDirection property
           '	to determine whether the up or down spin button was clicked
           Dim spinUp As Boolean = True
           If (e.SpinDirection = ScrollButton.Down) Then
               spinUp = False
           End If

           '	Use the NewDate property to determine what the date
           '	will be if the spin operation is not canceled
           Dim newDate As DateTime = e.NewDate

           '	If the up spin button was clicked, and the new date would be
           '	outside the current year, cancel the spin operation by setting
           '	the Cancel property to true.
           If (spinUp And newDate.Year <> DateTime.Today.Year) Then
               e.Cancel = True
           End If
       End If

   End Sub

NOTE: This example requires that the control's SpinButtonsVisible property be set to true, like so:
this.ultraCalendarCombo1.SpinButtonsVisible = true;

C#

private void ultraCalendarCombo1_BeforeSpin(object sender, Infragistics.Win.UltraWinSchedule.BeforeSpinEventArgs e)
{

	//	Use the BeforeSpinEventArgs' CurrentValue property
	//	to determine the control's current value
	if ( e.CurrentValue is System.DateTime )
	{
		DateTime dateVal = (DateTime)(e.CurrentValue);
		string info = string.Empty;


		//	Use the AfterSpinEventArgs' SpinDirection property
		//	to determine whether the up or down spin button was clicked
		bool spinUp = true;
		if ( e.SpinDirection == ScrollButton.Down )
			spinUp = false;
		
		//	Use the NewDate property to determine what the date
		//	will be if the spin operation is not canceled
		DateTime newDate = e.NewDate;

		//	If the up spin button was clicked, and the new date would be
		//	outside the current year, cancel the spin operation by setting
		//	the Cancel property to true.
		if ( spinUp && newDate.Year != DateTime.Today.Year )
			e.Cancel = true;
	}		
 
}