BeforeMonthScroll イベント (UltraCalendarCombo)

UltraCalendarCombo コントロールが特定の Month にスクロールする前に発生します。

シンタックス

Visual Basic

'宣言
 
Public Event BeforeMonthScroll As BeforeMonthScrollEventHandler

C#

public event BeforeMonthScrollEventHandler BeforeMonthScroll

イベント データ

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

プロパティ	解説
Cancel System.ComponentModel.CancelEventArgsから継承されます。
NewFirstMonth	コントロール内での表示月の最初の位置に来る新しい月。

解説

コントロールをスクロールしないように System.ComponentModel.CancelEventArgs.Cancel プロパティを使用して、BeforeMonthScroll イベントはキャンセルできます。

BeforeMonthScrollEventArgs.NewFirstMonth プロパティは、新しい UltraMonthViewMultiBase.FirstMonth になる新しい Month オブジェクトを返します。このプロパティは、Month を異なる UltraMonthViewMultiBase.FirstMonth に設定するために、異なる Month オブジェクトに設定することもできます。

使用例

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;

}