RadScheduler

By default, if the AppointmentContextMenus collection contains RadSchedulerContextMenus, the first one is displayed on the right-click of each Appointment. To specify a different context menu for a Appointment, use its ContextMenuID property.

The default factory returns instances of the Appointment class.

RadScheduler needs to create appointment instances in various stages of the control life cycle. You can use custom appointment classes by either implementing an IAppointmentFactory or by overriding the CreateAppointment() method.

You should use the CustomAttributeNames property when you want RadScheduler to populate the Attributes collection of the appointments.

This property is optional. If it's not specified the description field will not be visible in the insert/edit forms.

Setting this property to a non-empty string will enable the Description field regardless of the value of EnableDescriptionField.

This property is optional. If it's not specified the reminder drop-down will not be visible in the insert/edit forms.

Setting this property to a non-empty string will enable the reminder drop-down regardless of the value of Enabled.

This property is ignored in MonthView mode. If you need to set DayStartTime="00:00:00" and DayEndTime="23:59:59", it is recommended to set ShowFullTime="true" instead.

This property is ignored in MonthView mode. If you need to set DayStartTime="00:00:00" and DayEndTime="23:59:59", it is recommended to set ShowFullTime="true" instead.

This property is also used to indicate the target of the delete and move operations.

Currently, exact time rendering is supported only in Day, Week and MultiDay views.

Use the ExportSettings property to control the settings of the grouping operations in a Telerik RadScheduler control. This property is read-only; however, you can set the properties of the SchedulerGroupingSettings object it returns. The properties can be set declaratively using one of the following methods:

• Place an attribute in the opening tag of the Telerik RadScheduler control in the form Property-Subproperty, where Subproperty is a property of the SchedulerExportSettings object (for example, GroupingSettings-ExpandTooltip).
• Nest a <GroupingSettings> element between the opening and closing tags of the Telerik RadScheduler control.

The properties can also be set programmatically in the form Property.Subproperty (for example, GroupingSettings.ExpandTooltip). Common settings usually include the tool tips for the sorting controls.

Used this property to specify the first day rendered in week view.

This property is applied in week and month view.

This limit is used to prevent lockups when evaluating long recurring series. The default value should not be changed under normal conditions.

The height is applied to the textbox inside the default inline template. It will be ignored when using custom templates for the inline form.

If specified, the OnClientAppointmentContextMenu client-side event handler is called when an appointment has been right-clicked. Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with two properties:
  • get_appointment(), the instance of the appointment.
  • get_domEvent(), the original DOM event.

This event cannot be cancelled.

If specified, the OnClientAppointmentContextMenuItemClicking client-side event handler is called when an apointment context menu item is clicked, after RadScheduler has processed the event.

Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with two properties:
  • get_appointment(), the instance of the appointment.
  • get_item(), the clicked menu item.

This event cannot be cancelled.

If specified, the OnClientAppointmentContextMenuItemClicking client-side event handler is called when an apointment context menu item is clicked, before RadScheduler processes the click event.

Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with three properties:
  • get_appointment(), the instance of the appointment.
  • get_item(), the clicked menu item.
  • set_cancel(), used to cancel the event.

This event can be cancelled. Cancelling it will prevent any further processing of the command.

If specified, the OnClientAppointmentCreated client-side event handler is called when an appointment is received and has been rendered.

In the case of server-side binding, the event will not be raised.

When client-side binding is used, the event will be raised after the appointments are retrieved from the data service. The event will be raised for each appointment that has been retrieved from the web service.

Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with one property:
  • get_appointment(), the appointment that has been rendered.

This event cannot be cancelled.

If specified, the OnClientAppointmentDataBound client-side event handler is called when an appointment is received and is about to be rendered.

In the case of server-side binding, the event will not be raised.

When client-side binding is used, the event will be raised after the appointments are retrieved from the data service. The event will be raised for each appointment that has been retrieved from the web service.

Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with two properties:
  • get_appointment(), the instance of the appointment;
  • get_data(), the original data object retrieved from the web service.

This event cannot be cancelled.

If specified, the OnClientAppointmentMoveEnd client-side event handler is called when an appointment has been moved.

The event will also be fired when the move operation has been aborted by the user. In this case the get_isAbortedByUser() property of the event arguments will be set to "true".

The event will also fire if the appointment is dropped in its original location, but no postback will occur as the appointment is not altered.

Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with six properties:
  • get_appointment(), the instance of the appointment.
  • get_newStartTime(), the new start time of the appointment.
  • get_editingRecurringSeries(), a boolean value indicating whether the user has selected to edit the whole series.
  • get_targetSlot(), the target slot that the appointment has been moved to.
  • get_isAbortedByUser(), indicates whether the move operation has been aborted as a result of user action.
  • set_cancel(), set to true to cancel the move operation.

This event can be cancelled.

If specified, the OnClientAppointmentMoveStart client-side event handler is called when an appointment is about to be moved. Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with four properties:
  • get_appointment(), the instance of the appointment.
  • set_cancel(), set to true to cancel the move operation.

This event can be cancelled.

If specified, the OnClientAppointmentMoving client-side event handler is called when an appointment is being moved. Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with four properties:
  • get_appointment(), the instance of the appointment.
  • get_targetSlot(), the slot that the appointment currently occupies.
  • set_cancel(), set to true to cancel the move operation.

This event can be cancelled.

If specified, the OnClientAppointmentSerialized client-side event handler is called when an appointment has been serialized to a data object and is about to be sent to the Web Service.

In the case of server-side binding, the event will not be raised.

When client-side binding is used, the event will be raised before the appointment is sent to the data service.

Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with two properties:
  • get_appointment(), the instance of the appointment;
  • get_data(), the constructed data object that will be sent to the web service.

This event cannot be cancelled.

If specified, the OnClientAppointmentsPopulated client-side event handler is called when the scheduler has received appointments.

In the case of server-side binding, the event will not be raised.

When client-side binding is used, the event will be raised after the appointments are retrieved from the data service. The event will be raised again each time new data has been retrieved from the web service.

One parameter is passed to the handler:

• sender, the scheduler client object;

This event cannot be cancelled.

If specified, the OnClientAppointmentsPopulating client-side event handler is called when the scheduler is about to request appointments.

In the case of server-side binding, the event will not be raised.

When client-side binding is used, the event will be raised before the appointments are retrieved from the data service. The event will be raised again each time new data is about to be retrieved from the web service.

Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with two properties:
  • get_schedulerInfo(), the schedulerInfo object that will be passed to the web service method.
  • set_cancel(), used to cancel the event.

This event can be cancelled.

If specified, the OnClientAppointmentWebServiceDeleting client-side event handler is called when an appointment is about to be deleted via Web Service call.

In the case of server-side binding, the event will not be raised.

Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with three properties:
  • get_appointment(), the appointment that is about to be deleted.
  • get_editingRecurringSeries(), indicates whether the recurring series are being deleted.
  • set_cancel(), set to true cancel the operation.
  • get_schedulerInfo(), the schedulerInfo object that will be passed to the web service method.

This event can be cancelled.

If specified, the OnClientAppointmentWebServiceInserting client-side event handler is called when an appointment is about to be stored via Web Service call.

In the case of server-side binding, the event will not be raised.

Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with two properties:
  • get_appointment(), the appointment that is about to be inserted.
  • set_cancel(), set to true cancel the operation.
  • get_schedulerInfo(), the schedulerInfo object that will be passed to the web service method.

This event can be cancelled.

If specified, the OnClientAppointmentWebServiceUpdating client-side event handler is called when an appointment is about to be updated via Web Service call.

In the case of server-side binding, the event will not be raised.

Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with two properties:
  • get_appointment(), the appointment that is about to be updated.
  • set_cancel(), set to true cancel the operation.
  • get_schedulerInfo(), the schedulerInfo object that will be passed to the web service method.

This event can be cancelled.

If specified, the OnClientDataBound client-side event handler is called when the scheduler has been populated with data.

In the case of server-side binding, the event will be raised immediately after the control is initialized.

When client-side binding is used, the event will be raised when both the appointments and the resources are retrieved from the data service. The event will be raised again each time new data is retrieved from the web service.

One parameter is passed to the handler:

• sender, the scheduler client object;

This event cannot be cancelled.

If specified, the OnClientFormCreated client-side event handler is called when an edit/insert form has been created. Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with two properties:
  • get_appointment(), the instance of the appointment.
  • get_formElement(), the DOM element of the form.
  • get_mode(), enumerable of type Telerik.Web.UI.SchedulerFormMode. See SchedulerFormMode for the list of possible values.
  • get_editingRecurringSeries(), a boolean indicating if the user has chosen to edit the recurring series (true) or a single occurrence (false).

  This event cannot be cancelled.

If specified, the OnClientNavigationCommand client-side event handler is called when the scheduler is about to execute a navigation command.

Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with two properties:
  • get_command(), the navigation command that is being processed.
  • set_cancel(), used to cancel the event.

This event can be cancelled.

If specified, the OnNavigationComplete client-side event handler is called when a navigation command has been completed.

The event will be raised only when client-side binding is used.

Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with one properties:
  • get_command(), the navigation command that is being processed.

This event cannot be cancelled.

If specified, the OnClientRecurrenceActionDialogClosed client-side event handler is called when the recurrence action confirmation dialog has been closed. Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with three properties:
  • get_appointment(), the instance of the appointment.
  • get_editSeries(), the selected option from the dialog.

This event cannot be cancelled.

If specified, the OnClientRecurrenceActionDialogShowing client-side event handler is called when the recurrence action confirmation dialog is about to be shown. Two parameters are passed to the handler:

• sender, the scheduler client object;
• eventArgs with three properties:
  • get_appointment(), the instance of the appointment.
  • set_cancel(), set to true to suppress the confirmation dialog.
  • set_editSeries(), set to true or false to override the result from the dialog (only if it has been cancelled by calling eventArgs.set_cancel(true)).

This event can be cancelled.