OnBeforeHolidayRemoved Method

Raises the BeforeHolidayRemoved event before a Holiday is removed from the Holidays collection.

Syntax

Visual Basic

'Declaration
 
Protected Overridable Sub OnBeforeHolidayRemoved( _
   ByVal e As CancelableHolidayEventArgs _
) 

C#

protected virtual void OnBeforeHolidayRemoved( 
   CancelableHolidayEventArgs e
)

Parameters

e

A CancelableHolidayEventArgs that provides data for the event.

Remarks

Raising an event invokes the event handler through a delegate.

The OnBeforeHolidayRemoved method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Holidays to Inheritors: When overriding OnBeforeHolidayRemoved in a derived class, be sure to call the base class's OnBeforeHolidayRemoved method so that registered delegates receive the event.

Example

This example uses the CancelableHolidayEventArgs' Cancel property to disallow the removal of Holidays that span more than one day.

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

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinSchedule
Imports System.Diagnostics

    Private Sub ultraCalendarInfo1_BeforeHolidayRemoved(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinSchedule.CancelableHolidayEventArgs) Handles ultraCalendarInfo1.BeforeHolidayRemoved

        '----------------------------------------------------------------------------------------------------
        '	Description
        '	BeforeHolidayRemoved
        '
        '	Fires before a new holiday is removed from the component's Holidays collection.
        '	If canceled, the Holiday is not removed, and the AfterHolidayRemoved event does not fire.
        '
        '----------------------------------------------------------------------------------------------------

        If (e.Holiday.NumberOfDays > 1) Then
            '	To prevent the removal of the Appointment, set the Cancel
            '	property to true
            e.Cancel = True

            '	Let the end user know what happened
            Dim info As String = String.Empty
            info += "You do not have sufficient permissions to remove multi-day holidays." + vbCrLf

            MessageBox.Show(info, "BeforeHolidayRemoved", MessageBoxButtons.OK, MessageBoxIcon.Error)
        End If

    End Sub

C#

using System.Diagnostics;
using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinSchedule;

		private void ultraCalendarInfo1_BeforeHolidayRemoved(object sender, Infragistics.Win.UltraWinSchedule.CancelableHolidayEventArgs e)
		{		

			//----------------------------------------------------------------------------------------------------
			//	Description
			//	BeforeHolidayRemoved
			//
			//	Fires before a new holiday is removed from the component's Holidays collection.
			//	If canceled, the Holiday is not removed, and the AfterHolidayRemoved event does not fire.
			//
			//----------------------------------------------------------------------------------------------------
		
			if ( e.Holiday.NumberOfDays > 1 )
			{
				//	To prevent the removal of the Appointment, set the Cancel
				//	property to true
				e.Cancel = true;

				//	Let the end user know what happened
				string info = string.Empty;
				info += "You do not have sufficient permissions to remove multi-day holidays." + "\n";

				MessageBox.Show( info, "BeforeHolidayRemoved", MessageBoxButtons.OK, MessageBoxIcon.Error );
			}

		}

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