OnBeforeMonthScroll Method (UltraMonthViewMultiBase)

Used to invoke the BeforeMonthScroll event.

Syntax

Visual Basic

'Declaration
 
Protected Overridable Sub OnBeforeMonthScroll( _
   ByVal e As BeforeMonthScrollEventArgs _
) 

C#

protected virtual void OnBeforeMonthScroll( 
   BeforeMonthScrollEventArgs e
)

Parameters

e

An System.EventArgs that contains the event data.

Example

This example cancels the event when the month being scrolled to does not fall in the current year.

For an overview of how to handle events in Visual Basic or Visual C#, see Event Handlers in Visual Basic and Visual C#. For specific information and code examples illustrating how to consume events in your application, see Consuming Events in the .NET Framework Developer's Guide.

Visual Basic

Private Sub ultraMonthViewMulti1_BeforeMonthScroll(ByVal sender As System.Object, ByVal e As Infragistics.Win.UltraWinSchedule.BeforeMonthScrollEventArgs) Handles ultraMonthViewMulti1.BeforeMonthScroll

    '	The BeforeMonthScroll event is a "cancelable" event,
    '	which means that the action to which it corresponds can be
    '	prevented from happening by canceling the event.
    '	
    '	Canceling an event is very simple - just set the 'Cancel'
    '	property of the event arguments to true. The action will then
    '	be prevented from happening, and the corresponding "After"
    '	event will not fire.

    '	If the new first visible month is not in the current year,
    '	cancel the event
    If (e.NewFirstMonth.Year.YearNumber <> DateTime.Today.Year) Then
        e.Cancel = True
    End If

End Sub

C#

private void ultraMonthViewMulti1_BeforeMonthScroll(object sender, Infragistics.Win.UltraWinSchedule.BeforeMonthScrollEventArgs e)
{

	//	The BeforeMonthScroll event is a "cancelable" event,
	//	which means that the action to which it corresponds can be
	//	prevented from happening by canceling the event.
	//	
	//	Canceling an event is very simple - just set the 'Cancel'
	//	property of the event arguments to true. The action will then
	//	be prevented from happening, and the corresponding "After"
	//	event will not fire.

	//	If the new first visible month is not in the current year,
	//	cancel the event
	if ( e.NewFirstMonth.Year.YearNumber != 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