RadControls for WinForms

RELATED VIDEOS
Adding Custom Fields to RadScheduler Appointmentss In this video, you will learn how to add custom fields to the RadScheduler for WinForms. You'll learn how to create the required classes, mappings, and dialogs that make it easy to integrate any custom data in a Scheduler appointment. (Runtime: 19:48)
Introduction to RadScheduler for WinForms In this webinar, Telerik Developer Support Specialist Robert Shoemate will introduce RadScheduler and demonstrate how to utilize its powerful feature set in your own applications. By attending this webinar, you will learn about features such as codeless data binding, adding custom fields, and UI customization. (Runtime: 55:58)

The following tutorial will demonstrate how you can customize the default EditAppointmentDialog (shown above) by adding a custom field to it. In our case, we are going to add an E-mail field. This field will not only exist in the dialog as a control, but will also be stored as a value in the custom appointment provided below.

Here is a step by step guide how to achieve that:

1. First we have to create a new form (let's call it CustomAppointmentEditForm) which derives from EditAppointmentDialog in order to extend the default scheduler’s dialog.

   Note
   In VB.NET you need to open the designer file and add the inherits statement there Copy[VB.NET] Inherit the form in VB.NET <Global.Microsoft.VisualBasic.CompilerServices.DesignerGenerated()> _ Partial Class CustomAppointmentEditForm Inherits Telerik.WinControls.UI.Scheduler.Dialogs.EditAppointmentDialog

2. Open the dialog in Design Time and add a label and a text box to under the Resource label and text box. Name the text box txtEmail

3. Here is the form's implementation:

   Copy[C#] Extending the EditAppointmentDialog

   public partial class CustomAppointmentEditForm : EditAppointmentDialog
   {
       public CustomAppointmentEditForm()
       {
           InitializeComponent();
       }
   
       protected override void LoadSettingsFromEvent(IEvent ev)
       {
           base.LoadSettingsFromEvent(ev);
   
           AppointmentWithEmail appointmentWithEmail = ev as AppointmentWithEmail;
           if (appointmentWithEmail != null)
           {
               this.txtEmail.Text = appointmentWithEmail.Email;
           }
       }
   
       protected override void ApplySettingsToEvent(IEvent ev)
       {
           AppointmentWithEmail appointmentWithEmail = ev as AppointmentWithEmail;
           if (appointmentWithEmail != null)
           {
               appointmentWithEmail.Email = this.txtEmail.Text;
           }
           base.ApplySettingsToEvent(ev);
       }
   
       protected override IEvent CreateNewEvent()
       {
           return new AppointmentWithEmail();
       }
   }

   Copy[VB.NET] Extending the EditAppointmentDialog

   Public Class CustomAppointmentEditForm
       Public Sub New()
           InitializeComponent()
       End Sub
   
       Protected Overrides Sub LoadSettingsFromEvent(ByVal ev As IEvent)
           MyBase.LoadSettingsFromEvent(ev)
   
           Dim appointmentWithEmail As AppointmentWithEmail = TryCast(ev, AppointmentWithEmail)
           If appointmentWithEmail IsNot Nothing Then
               Me.txtEmail.Text = appointmentWithEmail.Email
           End If
       End Sub
   
       Protected Overrides Sub ApplySettingsToEvent(ByVal ev As IEvent)
           Dim appointmentWithEmail As AppointmentWithEmail = TryCast(ev, AppointmentWithEmail)
           If appointmentWithEmail IsNot Nothing Then
               appointmentWithEmail.Email = Me.txtEmail.Text
           End If
           MyBase.ApplySettingsToEvent(ev)
       End Sub
   
       Protected Overrides Function CreateNewEvent() As IEvent
           Return New AppointmentWithEmail()
       End Function
   End Class

4. Create a new appointment class (let's call it AppointmentWithEmail) which derives from the Appointment class and add an Email property as shown:

   Copy[C#] Extending the Appointment class

   public class AppointmentWithEmail : Appointment
   {
       public AppointmentWithEmail()
           : base()
       {
       }
       private string email = string.Empty;
       public string Email
       {
           get
           {
               return this.email;
           }
           set
           {
               if (this.email != value)
               {
                   this.email = value;
                   this.OnPropertyChanged("Email");
               }
           }
       }
   }

   Copy[VB.NET] Extending the Appointment class

   Public Class AppointmentWithEmail
       Inherits Appointment
       Public Sub New()
           MyBase.New()
       End Sub
   
       Private _email As String = String.Empty
       Public Property Email() As String
           Get
               Return Me._email
           End Get
           Set(ByVal value As String)
               If Me._email <> value Then
                   Me._email = value
                   Me.OnPropertyChanged("Email")
               End If
           End Set
       End Property
   End Class

5. Create an appointment factory which returns our AppointmentWithEmail when creating appointments:

   Copy[C#]

   public class CustomAppointmentFactory : IAppointmentFactory
   {
       #region IAppointmentFactory Members
       public IEvent CreateNewAppointment()
       {
           return new AppointmentWithEmail();
       }
       #endregion
   }

   Copy[VB.NET]

   Public Class CustomAppointmentFactory
       Implements IAppointmentFactory
   #Region "IAppointmentFactory Members"
       Public Function CreateNewAppointment() As IEvent Implements IAppointmentFactory.CreateNewAppointment
           Return New AppointmentWithEmail()
       End Function
   #End Region
   End Class

6. Subscribe to the AppointmentEditDialogShowing event and in the event handler use the AppointmentEditDialog property of the event arguments to change the default dialog with the custom one you just created. For optimization, you can create a global variable, which can be reused, instead of creating a new instance of the form every time.

   Copy[C#] Associating new EditAppointment dialog

   CustomAppointmentEditForm appointmentDialog = null;
   
   void radScheduler1_AppointmentEditDialogShowing(object sender, AppointmentEditDialogShowingEventArgs e)
   {
       if (this.appointmentDialog == null)
       {
           this.appointmentDialog = new CustomAppointmentEditForm();
       }
      e.AppointmentEditDialog = this.appointmentDialog;
   }

   Copy[VB.NET] Associating new EditAppointment dialog

   Private appointmentDialog As CustomAppointmentEditForm = Nothing
   
   Private Sub radScheduler1_AppointmentEditDialogShowing(ByVal sender As Object, ByVal e As AppointmentEditDialogShowingEventArgs)
       If Me.appointmentDialog Is Nothing Then
           Me.appointmentDialog = New CustomAppointmentEditForm()
       End If
       e.AppointmentEditDialog = Me.appointmentDialog
   End Sub

7. Last, but not least we should assign the custom AppointmentFactory to our RadScheduler. This will come in handy when you create your appointments in-line:

   Copy[C#] Extending the EditAppointmentDialog

   this.radScheduler1.AppointmentFactory = new CustomAppointmentFactory();

   Copy[VB.NET] Extending the EditAppointmentDialog

   Me.RadScheduler1.AppointmentFactory = New CustomAppointmentFactory()