Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

BeforeDisplayDayToolTip Event (UltraMonthViewMulti)

Fired before a day's tooltip is displayed.
Syntax
'Declaration
 
Public Event BeforeDisplayDayToolTip As BeforeDisplayDayToolTipEventHandler
public event BeforeDisplayDayToolTipEventHandler BeforeDisplayDayToolTip
Event Data

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

PropertyDescription
Cancel (Inherited from System.ComponentModel.CancelEventArgs) 
Date Returns the Date for the Day object associated with the tooltip.
Day Returns the Day object associated with the tooltip.
ToolTip Determines the message displayed in the tooltip.
Remarks

The BeforeDisplayDayToolTip event will not be fired if the UltraMonthViewMultiBase.TipStyle is set to None.

The BeforeDisplayDayToolTip event may be canceled using System.ComponentModel.CancelEventArgs.Cancel property to prevent the tooltip from being displayed.

The DayToolTipEventArgs.ToolTip property returns the tooltip that will be displayed to the user. This property may be changed to provide a different tooltip. The DayToolTipEventArgs.Day returns the Day object for which the tooltip will be displayed.

Example
NOTE: This example requires that the control's TipStyle property be set to 'Custom', like so:
Me.ultraMonthViewMulti1.TipStyle = Infragistics.Win.UltraWinSchedule.TipStyleDay.Custom
Private Sub ultraMonthViewMulti1_BeforeDisplayDayToolTip(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinSchedule.DayToolTipEventArgs) Handles ultraMonthViewMulti1.BeforeDisplayDayToolTip

       '	The BeforeDisplayDayToolTip 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 day for which the tooltip is being displayed is a weekend
       '	day, cancel the event and return, which will prevent tooltips
       '	from being displayed for weekend days
       If (e.Date.DayOfWeek = System.DayOfWeek.Saturday Or _
         e.Date.DayOfWeek = System.DayOfWeek.Sunday) Then
           e.Cancel = True
           Return
       End If

       '	Get the name of the day of the week
       Dim dayOfWeek As String = e.Day.DayOfWeek.LongDescriptionResolved

       '	Determine whether there is activity for the day if there isn't,
       '	we will set the ToolTip property of the event arguments to
       '	"No activity", and return.
       If (Not e.Day.HasActivity) Then
           e.ToolTip = dayOfWeek + ": No activity"
           Return
       Else
           '	The day has activity, determine what kind(s) and how many
           Dim tipText As String = String.Empty
           If (e.Day.Appointments.Count > 0) Then
               tipText += e.Day.Appointments.Count.ToString() + " Appointment(s)" + vbCrLf
           End If
           If (e.Day.Holidays.Count > 0) Then
               tipText += e.Day.Holidays.Count.ToString() + " Holiday(s)" + vbCrLf
           End If

           If (e.Day.Notes.Count > 0) Then
               tipText += e.Day.Notes.Count.ToString() + " Note(s)" + vbCrLf
           End If
           '	Set the ToolTip property to the custom string we built
           e.ToolTip = dayOfWeek + ":" + vbCrLf + tipText
       End If

   End Sub
NOTE: This example requires that the control's TipStyle property be set to 'Custom', like so:
this.ultraMonthViewMulti1.TipStyle = Infragistics.Win.UltraWinSchedule.TipStyleDay.Custom;
private void ultraMonthViewMulti1_BeforeDisplayDayToolTip(object sender, Infragistics.Win.UltraWinSchedule.DayToolTipEventArgs e)
{

	//	The BeforeDisplayDayToolTip 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 day for which the tooltip is being displayed is a weekend
	//	day, cancel the event and return, which will prevent tooltips
	//	from being displayed for weekend days
	if ( e.Date.DayOfWeek == System.DayOfWeek.Saturday ||
		 e.Date.DayOfWeek == System.DayOfWeek.Sunday )
	{
		e.Cancel = true;
		return;
	}

	//	Get the name of the day of the week
	string dayOfWeek = e.Day.DayOfWeek.LongDescriptionResolved;

	//	Determine whether there is activity for the day; if there isn't,
	//	we will set the ToolTip property of the event arguments to
	//	"No activity", and return.
	if ( ! e.Day.HasActivity )
	{
		e.ToolTip = dayOfWeek + ": No activity";
		return;
	}
	else
	{
		//	The day has activity, determine what kind(s) and how many
		string tipText = string.Empty;
		if ( e.Day.Appointments.Count > 0 )
			tipText += e.Day.Appointments.Count.ToString() + " Appointment(s)" + "\n";
		if ( e.Day.Holidays.Count > 0 )
			tipText += e.Day.Holidays.Count.ToString() + " Holiday(s)" + "\n";
		if ( e.Day.Notes.Count > 0 )
			tipText += e.Day.Notes.Count.ToString() + " Note(s)" + "\n";

		//	Set the ToolTip property to the custom string we built
		e.ToolTip = dayOfWeek + ":" + "\n" + tipText;
	}

}
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