BeforeDisplayMonthPopup イベント (UltraCalendarCombo)

月ポップアップが表示される前に発生します。

シンタックス

Visual Basic

'宣言
 
Public Event BeforeDisplayMonthPopup As BeforeDisplayMonthPopupEventHandler

C#

public event BeforeDisplayMonthPopupEventHandler BeforeDisplayMonthPopup

イベント データ

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

プロパティ	解説
Cancel System.ComponentModel.CancelEventArgsから継承されます。
Month	ポップアップが表示される月を返します。

解説

UltraMonthViewMultiBase.AllowMonthPopup が True に設定される場合、ユーザーが Infragistics.Win.UltraWinSchedule.MonthViewMulti.MonthHeaderAreaUIElement でマウスの左ボタンを押したときに Infragistics.Win.UltraWinSchedule.MonthViewMulti.UltraMonthPopupControl が表示されます。Infragistics.Win.UltraWinSchedule.MonthViewMulti.UltraMonthPopupControl は、スクロール リストで現在の月の 3 か月前および後を表示します。これで月ヘッダーが押されたときにユーザーが特定の月をその位置に素早くナビゲートできます。

コントロールが Infragistics.Win.UltraWinSchedule.MonthViewMulti.UltraMonthPopupControl を表示しないように System.ComponentModel.CancelEventArgs.Cancel プロパティを使用して、BeforeDisplayMonthPopup イベントはキャンセルできます。

BeforeDisplayMonthPopupEventArgs.Month プロパティは、Infragistics.Win.UltraWinSchedule.MonthViewMulti.MonthHeaderAreaUIElement がクリックされた Month オブジェクトを返します。

使用例

Visual Basic

Private Sub ultraMonthViewMulti1_BeforeDisplayMonthPopup(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinSchedule.BeforeDisplayMonthPopupEventArgs) Handles ultraMonthViewMulti1.BeforeDisplayMonthPopup

    '	The BeforeDisplayMonthPopup 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 month for which the popup is being displayed is
    '	not in the current year, we will cancel the event, effectively
    '	diallowing the displaying of the popup.
    If (e.Month.Year.YearNumber <> DateTime.Today.Year) Then
        e.Cancel = True
    End If

End Sub

C#

private void ultraMonthViewMulti1_BeforeDisplayMonthPopup(object sender, Infragistics.Win.UltraWinSchedule.BeforeDisplayMonthPopupEventArgs e)
{

	//	The BeforeDisplayMonthPopup 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 month for which the popup is being displayed is
	//	not in the current year, we will cancel the event, effectively
	//	diallowing the displaying of the popup.
	if ( e.Month.Year.YearNumber != DateTime.Today.Year )
		e.Cancel = true;	
	
}