Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

BeforeSpin Event

Fired before the value changes when pressing the spin buttons.
Syntax
'Declaration
 
Public Event BeforeSpin As BeforeSpinEventHandler
public event BeforeSpinEventHandler BeforeSpin
Event Data

The event handler receives an argument of type BeforeSpinEventArgs containing data related to this event. The following BeforeSpinEventArgs properties provide information specific to this event.

PropertyDescription
Cancel (Inherited from System.ComponentModel.CancelEventArgs) 
CurrentValue Returns the object's current value.
NewDate Returns the date that will be scrolled to.
SpinDirection Returns the direction of the spin button pressed.
Remarks

The BeforeSpin event is invoked when the Value is about to change as a result of a spin, whether it be via the keyboard or the spin buttons. The BeforeSpinEventArgs provides the current Value, the new value and the BeforeSpinEventArgs.SpinDirection of the spin button pressed. The change can be prevented by setting the System.ComponentModel.CancelEventArgs.Cancel property to true.

Example
NOTE: This example requires that the control's SpinButtonsVisible property be set to true, like so:
Me.ultraCalendarCombo1.SpinButtonsVisible = True
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;
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;
	}		
 
}
Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also