New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

Definition

Namespace:Telerik.Web.UI

Inheritance: Telerik.Web.UI.RadWebControlTelerik.Web.UI.RadScheduler

Events

Adds a appointmentClick event handler for the radscheduler

JS
add_appointmentClick
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentContextMenu event handler for the radscheduler

JS
add_appointmentContextMenu
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentCreated event handler for the radscheduler

JS
add_appointmentCreated
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentDataBound event handler for the radscheduler

JS
add_appointmentDataBound
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentDeleting event handler for the radscheduler

JS
add_appointmentDeleting
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentDoubleClick event handler for the radscheduler

JS
add_appointmentDoubleClick
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentEditing event handler for the radscheduler

JS
add_appointmentEditing
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentInserting event handler for the radscheduler

JS
add_appointmentInserting
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentMoveEnd event handler for the radscheduler

JS
add_appointmentMoveEnd
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentMoveStart event handler for the radscheduler

JS
add_appointmentMoveStart
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentMoving event handler for the radscheduler

JS
add_appointmentMoving
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentResizeEnd event handler for the radscheduler

JS
add_appointmentResizeEnd
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentResizeStart event handler for the radscheduler

JS
add_appointmentResizeStart
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentResizing event handler for the radscheduler

JS
add_appointmentResizing
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentsPopulated event handler for the radscheduler

JS
add_appointmentsPopulated
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentsPopulating event handler for the radscheduler

JS
add_appointmentsPopulating
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentWebServiceDeleting event handler for the radscheduler

JS
add_appointmentWebServiceDeleting
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentWebServiceInserting event handler for the radscheduler

JS
add_appointmentWebServiceInserting
Parameters:handlerFunction

The event handler function to attach

Adds a appointmentWebServiceUpdating event handler for the radscheduler

JS
add_appointmentWebServiceUpdating
Parameters:handlerFunction

The event handler function to attach

Adds a dataBound event handler for the radscheduler

JS
add_dataBound
Parameters:handlerFunction

The event handler function to attach

Adds a formCreated event handler for the radscheduler

JS
add_formCreated
Parameters:handlerFunction

The event handler function to attach

Adds a navigationCommand event handler for the radscheduler

JS
add_navigationCommand
Parameters:handlerFunction

The event handler function to attach

Adds a navigationComplete event handler for the radscheduler

JS
add_navigationComplete
Parameters:handlerFunction

The event handler function to attach

Adds a recurrenceActionDialogClosed event handler for the radscheduler

JS
add_recurrenceActionDialogClosed
Parameters:handlerFunction

The event handler function to attach

Adds a recurrenceActionDialogShowing event handler for the radscheduler

JS
add_recurrenceActionDialogShowing
Parameters:handlerFunction

The event handler function to attach

Adds a recurrenceExceptionCreating event handler for the radscheduler

JS
add_recurrenceExceptionCreating
Parameters:handlerFunction

The event handler function to attach

Adds a recurrenceExceptionsRemoving event handler for the radscheduler

JS
add_recurrenceExceptionsRemoving
Parameters:handlerFunction

The event handler function to attach

Adds a reminderDismissing event handler for the radscheduler

JS
add_reminderDismissing
Parameters:handlerFunction

The event handler function to attach

Adds a reminderSnoozing event handler for the radscheduler

JS
add_reminderSnoozing
Parameters:handlerFunction

The event handler function to attach

Adds a reminderTriggering event handler for the radscheduler

JS
add_reminderTriggering
Parameters:handlerFunction

The event handler function to attach

Adds a requestFailed event handler for the radscheduler

JS
add_requestFailed
Parameters:handlerFunction

The event handler function to attach

Adds a requestSuccess event handler for the radscheduler

JS
add_requestSuccess
Parameters:handlerFunction

The event handler function to attach

Adds a resourcesPopulated event handler for the radscheduler

JS
add_resourcesPopulated
Parameters:handlerFunction

The event handler function to attach

Adds a resourcesPopulating event handler for the radscheduler

JS
add_resourcesPopulating
Parameters:handlerFunction

The event handler function to attach

Adds a timeSlotClick event handler for the radscheduler

JS
add_timeSlotClick
Parameters:handlerFunction

The event handler function to attach

Adds a timeSlotContextMenu event handler for the radscheduler

JS
add_timeSlotContextMenu
Parameters:handlerFunction

The event handler function to attach

Removes a appointmentClick event handler from the radscheduler

JS
remove_appointmentClick
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentContextMenu event handler from the radscheduler

JS
remove_appointmentContextMenu
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentCreated event handler from the radscheduler

JS
remove_appointmentCreated
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentDataBound event handler from the radscheduler

JS
remove_appointmentDataBound
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentDeleting event handler from the radscheduler

JS
remove_appointmentDeleting
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentDoubleClick event handler from the radscheduler

JS
remove_appointmentDoubleClick
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentEditing event handler from the radscheduler

JS
remove_appointmentEditing
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentInserting event handler from the radscheduler

JS
remove_appointmentInserting
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentMoveEnd event handler from the radscheduler

JS
remove_appointmentMoveEnd
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentMoveStart event handler from the radscheduler

JS
remove_appointmentMoveStart
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentMoving event handler from the radscheduler

JS
remove_appointmentMoving
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentResizeEnd event handler from the radscheduler

JS
remove_appointmentResizeEnd
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentResizeStart event handler from the radscheduler

JS
remove_appointmentResizeStart
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentResizing event handler from the radscheduler

JS
remove_appointmentResizing
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentsPopulated event handler from the radscheduler

JS
remove_appointmentsPopulated
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentsPopulating event handler from the radscheduler

JS
remove_appointmentsPopulating
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentWebServiceDeleting event handler from the radscheduler

JS
remove_appointmentWebServiceDeleting
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentWebServiceInserting event handler from the radscheduler

JS
remove_appointmentWebServiceInserting
Parameters:handlerFunction

The event handler function to remove

Removes a appointmentWebServiceUpdating event handler from the radscheduler

JS
remove_appointmentWebServiceUpdating
Parameters:handlerFunction

The event handler function to remove

Removes a dataBound event handler from the radscheduler

JS
remove_dataBound
Parameters:handlerFunction

The event handler function to remove

Removes a formCreated event handler from the radscheduler

JS
remove_formCreated
Parameters:handlerFunction

The event handler function to remove

Removes a navigationCommand event handler from the radscheduler

JS
remove_navigationCommand
Parameters:handlerFunction

The event handler function to remove

Removes a navigationComplete event handler from the radscheduler

JS
remove_navigationComplete
Parameters:handlerFunction

The event handler function to remove

Removes a recurrenceActionDialogClosed event handler from the radscheduler

JS
remove_recurrenceActionDialogClosed
Parameters:handlerFunction

The event handler function to remove

Removes a recurrenceActionDialogShowing event handler from the radscheduler

JS
remove_recurrenceActionDialogShowing
Parameters:handlerFunction

The event handler function to remove

Removes a recurrenceExceptionCreating event handler from the radscheduler

JS
remove_recurrenceExceptionCreating
Parameters:handlerFunction

The event handler function to remove

Removes a recurrenceExceptionsRemoving event handler from the radscheduler

JS
remove_recurrenceExceptionsRemoving
Parameters:handlerFunction

The event handler function to remove

Removes a reminderDismissing event handler from the radscheduler

JS
remove_reminderDismissing
Parameters:handlerFunction

The event handler function to remove

Removes a reminderSnoozing event handler from the radscheduler

JS
remove_reminderSnoozing
Parameters:handlerFunction

The event handler function to remove

Removes a reminderTriggering event handler from the radscheduler

JS
remove_reminderTriggering
Parameters:handlerFunction

The event handler function to remove

Removes a requestFailed event handler from the radscheduler

JS
remove_requestFailed
Parameters:handlerFunction

The event handler function to remove

Removes a requestSuccess event handler from the radscheduler

JS
remove_requestSuccess
Parameters:handlerFunction

The event handler function to remove

Removes a resourcesPopulated event handler from the radscheduler

JS
remove_resourcesPopulated
Parameters:handlerFunction

The event handler function to remove

Removes a resourcesPopulating event handler from the radscheduler

JS
remove_resourcesPopulating
Parameters:handlerFunction

The event handler function to remove

Removes a timeSlotClick event handler from the radscheduler

JS
remove_timeSlotClick
Parameters:handlerFunction

The event handler function to remove

Removes a timeSlotContextMenu event handler from the radscheduler

JS
remove_timeSlotContextMenu
Parameters:handlerFunction

The event handler function to remove

Methods

Deletes the specified Appointment. Postbacks if not bound to a web service.

JS
deleteAppointment(Telerik.Web.UI.SchedulerAppointment appointment, Boolean deleteSeries): void
Parameters:appointmentTelerik.Web.UI.SchedulerAppointment

The appointment to delete.

deleteSeriesBoolean

For recurring appointments only. True if you want to delete the recurring series

Deletes the specified Appointment. This method is identical to deleteAppointment, but the user is presented with a confirmation dialog if the deleted appointment is recurring.

JS
deleteAppointmentWithConfirmation(Telerik.Web.UI.SchedulerAppointment appointment): void
Parameters:appointmentTelerik.Web.UI.SchedulerAppointment

The appointment to delete.

Converts a date time object from client date format to UTC using the timeZoneOffset property.

JS
displayToUtc(Date displayDate): Date
Parameters:displayDateDate

The date to convert.

Returns:

Date

The date in UTC format which corresponds to the supplied client format date.

Starts editing the specified Appointment.

JS
editAppointment(Telerik.Web.UI.SchedulerAppointment appointment, Boolean editSeries): void
Parameters:appointmentTelerik.Web.UI.SchedulerAppointment

The appointment to edit.

editSeriesBoolean

For recurring appointments only. True if you want to edit the recurring series

Starts editing the specified Appointment. This method is identical to editAppointment, but the user is presented with a confirmation dialog if the edited appointment is recurring.

JS
editAppointmentWithConfirmation(Telerik.Web.UI.SchedulerAppointment appointment): void
Parameters:appointmentTelerik.Web.UI.SchedulerAppointment

The appointment to edit.

Gets the model that represents the current view. The model is responsible for mapping time slots to DOM elements and appointments to time slots.

JS
get_activeModel(): Telerik.Web.UI.ISchedulerModel
Returns:

Telerik.Web.UI.ISchedulerModel

The model that represents the current view.

Gets a value indicating if the appointments can be deleted.

JS
get_allowDelete(): Boolean
Returns:

Boolean

true if the appointment deleting is allowed

Gets a value indicating if the appointments can be edited. This includes moving and resizing.

JS
get_allowEdit(): Boolean
Returns:

Boolean

true if the appointment editing is allowed

Gets a value indicating if the appointments can be inserted.

JS
get_allowInsert(): Boolean
Returns:

Boolean

true if the appointment inserting is allowed

Gets a collection of all loaded appointments.

JS
get_appointments(): Telerik.Web.UI.SchedulerAppointmentCollection
Returns:

Telerik.Web.UI.SchedulerAppointmentCollection

Collection of all loaded appointments.

Gets a collection of all attributes of the scheduler.

JS
get_attributes(): Telerik.Web.UI.SchedulerAttributeCollection
Returns:

Telerik.Web.UI.SchedulerAttributeCollection

Collection of all attributes of the scheduler.

Gets the currently edited appointment.

JS
get_currentAppointment(): Telerik.Web.UI.SchedulerAppointment
Returns:

Telerik.Web.UI.SchedulerAppointment

The currently edited appointment. Null if no appointment is edited at the moment.

Gets a value indicating whether a delete confirmation dialog should be displayed when the user clicks the "delete" button of an appointment.

JS
get_displayDeleteConfirmation(): Boolean
Returns:

Boolean

true if the confirmation dialog should be displayed

Gets a value indicating whether a recurrence action dialog should be displayed when moving recurrent appointments.

JS
get_displayRecurrenceActionDialogOnMove(): Boolean
Returns:

Boolean

true if the confirmation dialog should be displayed

Gets the duration between two timeslots (including their own duration).

JS
get_durationBetweenTimeSlots(Telerik.Web.UI.ISchedulerTimeSlot startSlot, Telerik.Web.UI.ISchedulerTimeSlot endSlot): Number
Parameters:startSlotTelerik.Web.UI.ISchedulerTimeSlot

The first slot

endSlotTelerik.Web.UI.ISchedulerTimeSlot

The last slot

Returns:

Number

The duration between two timeslots in milliseconds.

Gets the duration of the area formed by the selected time slots.

JS
get_durationOfSelectedArea(): Number
Returns:

Number

The sum of the durations of the selected time slots as milliseconds.

Gets the start date of the current view. In day view, this is the start of the visible day.

JS
get_firstDayStart(): Date
Returns:

Date

The start date of the current view.

Gets the name of the resource to group by. Can also be in the format "Date,[Resource Name]" when grouping by date.

JS
get_groupBy(): String
Returns:

String

The name of the resource to group by.

Gets the height of RadScheduler.

JS
get_height(): String
Returns:

String

The height of RadScheduler.

Gets the hours panel time format string.

JS
get_hoursPanelTimeFormat(): String
Returns:

String

The hours panel time format string.

Gets the minimum height of the inline insert/edit template in pixels.

JS
get_minimumInlineFormHeight(): Number
Returns:

Number

The minimum height of the inline insert

Gets the minimum width of the inline insert/edit template in pixels.

JS
get_minimumInlineFormWidth(): Number
Returns:

Number

The minimum width of the inline insert

Gets the number of minutes which a single row represents.

JS
get_minutesPerRow(): Number
Returns:

Number

The number of minutes which a single row represents.

Gets the number of rows that are hovered when the mouse is over the appointment area.

JS
get_numberOfHoveredRows(): Number
Returns:

Number

The number of rows that are hovered when the mouse is over the appointment area.

Gets a value indicating whether RadScheduler is in read-only mode.

JS
get_readOnly(): Boolean
Returns:

Boolean

true if the scheduler is read

Gets a collection of all loaded resources.

JS
get_resources(): Telerik.Web.UI.SchedulerResourceCollection
Returns:

Telerik.Web.UI.SchedulerResourceCollection

Collection of all loaded resources.

Gets a collection of all loaded resource style mappings.

JS
get_resourceStyles(): Telerik.Web.UI.ResourceStyleMappingCollection
Returns:

Telerik.Web.UI.ResourceStyleMappingCollection

Collection of all loaded resource style mappings.

Gets a collection of all loaded resource types.

JS
get_resourceTypes(): Telerik.Web.UI.ResourceTypeCollection
Returns:

Telerik.Web.UI.ResourceTypeCollection

Collection of all loaded resource types.

Gets the height of RadScheduler rows.

JS
get_rowHeight(): String
Returns:

String

The height of RadScheduler rows.

Gets the currently selected date.

JS
get_selectedDate(): Date
Returns:

Date

the currently selected date.

Gets the currently selected time slots.

JS
get_selectedSlots(): Array
Returns:

Array

the currently selected time slots.

Gets the type of the currently selected view.

JS
get_selectedView(): Telerik.Web.UI.SchedulerViewType
Returns:

Telerik.Web.UI.SchedulerViewType

The currently selected view.

Gets a value indicating whether to display the complete day (24-hour view) or the range between dayStartTime and dayEndTime.

JS
get_showFullTime(): Boolean
Returns:

Boolean

true if showing the complete day

Gets the number of rows each time label spans.

JS
get_timeLabelRowSpan(): Number
Returns:

Number

The number of rows each time label spans.

The web service to be used for binding this instance of RadScheduler.

JS
get_webServiceSettings(): Telerik.Web.UI.SchedulerWebServiceSettings
Returns:

Telerik.Web.UI.SchedulerWebServiceSettings

The web service to be used for binding this instance of RadScheduler.

Gets the appointment that corresponds to the specified DOM element.

JS
getAppointmentFromDomElement(Element element): Telerik.Web.UI.SchedulerAppointment
Parameters:elementElement

The appointment DOM element

Returns:

Telerik.Web.UI.SchedulerAppointment

The corresponding appointment. Null if the element does not belong to an appointment.

Hides the currently shown modal advanced form.

JS
hideAdvancedForm(): void

Hides the currently shown inline form.

JS
hideInlineForm(): void

Stores the specified Appointment. Postbacks if not bound to a web service.

JS
insertAppointment(Telerik.Web.UI.SchedulerAppointment appointment): void
Parameters:appointmentTelerik.Web.UI.SchedulerAppointment

The appointment to insert.

Prepares the specified appointment for editing. If the specified appointment is not recurring, the method does nothing and returns the same appointment. If the appointment is recurring and editSeries is set to true the method returns the recurrence parent. Otherwise, the method clones the appointment and updates it state to recurrence exception.

JS
prepareToEdit(Telerik.Web.UI.SchedulerAppointment appointmentToEdit, Boolean editSeries): void
Parameters:appointmentToEditTelerik.Web.UI.SchedulerAppointment

The appointment to prepare for editing.

editSeriesBoolean

True if you want to edit the recurring series

Web Service binding only. Rebinds the scheduler from the web service.

JS
rebind(): void

Web Service binding only. Removes the associated recurrence exceptions.

JS
removeRecurrenceExceptions(Telerik.Web.UI.SchedulerAppointment appointment): void
Parameters:appointmentTelerik.Web.UI.SchedulerAppointment

The master appointment for the recurrence series.

Updates the control layout. Call this function after changing the size of the control.

JS
repaint(): void

Sets a value indicating if the appointments can be deleted.

JS
set_allowDelete(Boolean allowDelete): void
Parameters:allowDeleteBoolean

true if the appointment deleting is allowed

Sets a value indicating if the appointments can be edited.

JS
set_allowEdit(Boolean allowEdit): void
Parameters:allowEditBoolean

true if the appointment editing is allowed

Sets a value indicating if the appointments can be inserted.

JS
set_allowInsert(Boolean allowDelete): void
Parameters:allowDeleteBoolean

true if the appointment inserting is allowed

Sets a value indicating whether a delete confirmation dialog should be displayed when the user clicks the "delete" button of an appointment.

JS
set_displayDeleteConfirmation(Boolean displayDeleteConfirmation): void
Parameters:displayDeleteConfirmationBoolean

true if the confirmation dialog should be displayed

Sets a value indicating whether a recurrence action dialog should be displayed when moving recurrent appointments.

JS
set_displayRecurrenceActionDialogOnMove(Boolean displayDeleteConfirmation): void
Parameters:displayDeleteConfirmationBoolean

true if the confirmation dialog should be displayed

Sets the height of RadScheduler.

JS
set_height(String value): void
Parameters:valueString

The height of RadScheduler.

Sets the minimum height of the inline insert/edit template in pixels.

JS
set_minimumInlineFormHeight(Number value): void
Parameters:valueNumber

The minimum height of the inline insert

Sets the minimum width of the inline insert/edit template in pixels.

JS
set_minimumInlineFormWidth(Number value): void
Parameters:valueNumber

The minimum width of the inline insert

Sets the number of rows that are hovered when the mouse is over the appointment area.

JS
set_numberOfHoveredRows(Number value): void
Parameters:valueNumber

The number of rows that are hovered when the mouse is over the appointment area.

Sets a value indicating whether RadScheduler is in read-only mode.

JS
set_readOnly(Boolean readOnly): void
Parameters:readOnlyBoolean

true if the scheduler is read

Web Service binding only. Sets the currently selected date.

JS
set_selectedDate(Date value): void
Parameters:valueDate

The currently selected date.

Web Service binding only. Sets the currently selected view type.

JS
set_selectedView(Telerik.Web.UI.SchedulerViewType selectedView): void
Parameters:selectedViewTelerik.Web.UI.SchedulerViewType

The view to switch to.

Web Service binding only. Sets a value indicating whether to display the complete day (24-hour view) or the range between dayStartTime and dayEndTime.

JS
set_showFullTime(Boolean value): void
Parameters:valueBoolean

true if showing the complete day

Shows the advanced edit form populated with the specified appointment.

JS
showAdvancedEditForm(Telerik.Web.UI.SchedulerAppointment appointment, Boolean editSeries): void
Parameters:appointmentTelerik.Web.UI.SchedulerAppointment

The appointment to edit.

editSeriesBoolean

For recurring appointments only. True if you want to edit the recurring series

Shows the advanced insert form populated with the specified appointment start date.

JS
showAdvancedInsertForm(Date startDate): void
Parameters:startDateDate

The start date for the appointment.

Shows the advanced insert form populated with the specified appointment start date. The appointment will be initially marked as all-day.

JS
showAllDayAdvancedInsertForm(Date startDate): void
Parameters:startDateDate

The start date for the appointment.

Shows the in-line insert form for an all-day appointment on the specified date. Applicable in Day/Week/MultiDay view.

JS
showAllDayInlineInsertForm(Date date): void
Parameters:dateDate

The day for which to show the insert form.

Shows the in-line edit form for the specified appointment. A postback will occur if a custom InlineEditTemplate is in use.

JS
showInlineEditForm(Telerik.Web.UI.SchedulerAppointment appointment, Boolean editSeries): void
Parameters:appointmentTelerik.Web.UI.SchedulerAppointment

The appointment to edit.

editSeriesBoolean

For recurring appointments only. true if you want to edit the recurring series

Shows the in-line insert form at the specified time slot. The formCreating client-side event will be fired. A postback will occur if a custom InlineInsertTemplate is in use.

JS
showInlineInsertForm(Telerik.Web.UI.ISchedulerTimeSlot timeSlot): void
Parameters:timeSlotTelerik.Web.UI.ISchedulerTimeSlot

The time slot in which to place the insert form.

Updates the specified Appointment. Postbacks if not bound to a web service.

JS
updateAppointment(Telerik.Web.UI.SchedulerAppointment appointment, Boolean editSeries): void
Parameters:appointmentTelerik.Web.UI.SchedulerAppointment

The appointment to update.

editSeriesBoolean

True if you want to edit the recurring series

Converts a date time object from UTC to client date format using the timeZoneOffset property.

JS
utcToDisplay(Date utcDate): Date
Parameters:utcDateDate

The date to convert.

Returns:

Date

The date in client format which corresponds to the supplied UTC date.

Not finding the help you need?
Contact Support