Scheduler

Example

<kendo-scheduler>
    <current-time-marker />
    <editable></editable>
    <group></group>
    <messages />
    <ongoing-events />
    <pdf></pdf>
    <resources></resources>
    <scheduler-all-day-event-template></scheduler-all-day-event-template>
    <scheduler-datasource></scheduler-datasource>
    <scheduler-event-template></scheduler-event-template>
    <scheduler-footer />
    <toolbar></toolbar>
    <views />
</kendo-scheduler>

ChildTags

Tag Name Details
current-time-marker SchedulerCurrentTimeMarkerSettingsTagHelper
editable SchedulerEditableSettingsTagHelper
group SchedulerGroupSettingsTagHelper
messages SchedulerMessagesSettingsTagHelper
ongoing-events SchedulerOngoingEventsSettingsTagHelper
pdf SchedulerPdfSettingsTagHelper
resources SchedulerResourcesTagHelper
scheduler-all-day-event-template TemplateTagHelper
scheduler-datasource SchedulerDataSourceTagHelper
scheduler-event-template TemplateTagHelper
scheduler-footer SchedulerFooterSettingsTagHelper
toolbar SchedulerToolbarsTagHelper
views SchedulerViewsTagHelper

Attributes

Attribute Type Description
name String Sets the name of the component.
all-day-event-template String The template used to render the "all day" scheduler events.The fields which can be used in the template are: description String - the event description; end Date - the event end date; isAllDay Boolean - if true the event is "all day"; resources Array - the event resources; start Date - the event start date or title String - the event title.
all-day-event-template-handler String The template used to render the "all day" scheduler events.The fields which can be used in the template are: description String - the event description; end Date - the event end date; isAllDay Boolean - if true the event is "all day"; resources Array - the event resources; start Date - the event start date or title String - the event title.
all-day-event-template-id String The template used to render the "all day" scheduler events.The fields which can be used in the template are: description String - the event description; end Date - the event end date; isAllDay Boolean - if true the event is "all day"; resources Array - the event resources; start Date - the event start date or title String - the event title.
all-day-event-template-view IHtmlContent The template used to render the "all day" scheduler events.The fields which can be used in the template are: description String - the event description; end Date - the event end date; isAllDay Boolean - if true the event is "all day"; resources Array - the event resources; start Date - the event start date or title String - the event title.
all-day-slot Boolean If set to true the scheduler will display a slot for "all day" events.
as-module Boolean
auto-bind Boolean If set to false the widget will not bind to the data source during initialization. In this case data binding will occur when the change event of the data source is fired. That will also apply for data sources for the resources used in the widget. By default the widget will bind to the data source specified in the configuration.
data-source-id String The Id of the data source.
date DateTime The current date of the scheduler. Used to determine the period which is displayed by the widget.
date-header-template String The template used to render the date header cells.By default the scheduler renders the date using a custom date format - "ddd M/dd". The "ddd" specifier represents the abbreviated name of the week day and will be localized using the current Kendo UI culture. If the developer wants to control the day and month order, then one needs to define a custom template.The fields which can be used in the template are: date - represents the major tick date..
date-header-template-id String The template used to render the date header cells.By default the scheduler renders the date using a custom date format - "ddd M/dd". The "ddd" specifier represents the abbreviated name of the week day and will be localized using the current Kendo UI culture. If the developer wants to control the day and month order, then one needs to define a custom template.The fields which can be used in the template are: date - represents the major tick date..
date-header-template-view IHtmlContent The template used to render the date header cells.By default the scheduler renders the date using a custom date format - "ddd M/dd". The "ddd" specifier represents the abbreviated name of the week day and will be localized using the current Kendo UI culture. If the developer wants to control the day and month order, then one needs to define a custom template.The fields which can be used in the template are: date - represents the major tick date..
end-time DateTime The end time of the week and day views. The scheduler will display events ending before the endTime.
event-template-handler String The template used to render the scheduler events.The fields which can be used in the template are: description String - the event description; end Date - the event end date; resources Array - the event resources; start Date - the event start date or title String - the event title.
event-template-id String The template used to render the scheduler events.The fields which can be used in the template are: description String - the event description; end Date - the event end date; resources Array - the event resources; start Date - the event start date or title String - the event title.
event-template-view IHtmlContent The template used to render the scheduler events.The fields which can be used in the template are: description String - the event description; end Date - the event end date; resources Array - the event resources; start Date - the event start date or title String - the event title.
is-in-client-template Boolean When placing a Tag Helper within a Kendo Template, set the type to text/html and add the is-in-client-template="true" attribute.
deferred Boolean Suppress initialization script rendering. Note that this options should be used in conjunction with DeferredScripts method.
date-header-template-handler String The template used to render the date header cells.By default the scheduler renders the date using a custom date format - "ddd M/dd". The "ddd" specifier represents the abbreviated name of the week day and will be localized using the current Kendo UI culture. If the developer wants to control the day and month order, then one needs to define a custom template.The fields which can be used in the template are: date - represents the major tick date..
event-template String The template used to render the scheduler events.The fields which can be used in the template are: description String - the event description; end Date - the event end date; resources Array - the event resources; start Date - the event start date or title String - the event title.
group-header-template String The template used to render the group headers of scheduler day, week, workWeek and timeline views.The fields which can be used in the template are: text String - the group text; color String - the group color; value - the group value; field String - the field of the scheduler event which contains the resource id; title String - the 'title' option of the resource or name String - the 'name' option of the resource.
group-header-template-handler String The template used to render the group headers of scheduler day, week, workWeek and timeline views.The fields which can be used in the template are: text String - the group text; color String - the group color; value - the group value; field String - the field of the scheduler event which contains the resource id; title String - the 'title' option of the resource or name String - the 'name' option of the resource.
group-header-template-id String The template used to render the group headers of scheduler day, week, workWeek and timeline views.The fields which can be used in the template are: text String - the group text; color String - the group color; value - the group value; field String - the field of the scheduler event which contains the resource id; title String - the 'title' option of the resource or name String - the 'name' option of the resource.
group-header-template-view IHtmlContent The template used to render the group headers of scheduler day, week, workWeek and timeline views.The fields which can be used in the template are: text String - the group text; color String - the group color; value - the group value; field String - the field of the scheduler event which contains the resource id; title String - the 'title' option of the resource or name String - the 'name' option of the resource.
has-client-component Boolean
height Double The height of the widget. Numeric values are treated as pixels.
major-tick Int32 The number of minutes represented by a major tick.
major-time-header-template String The template used to render the major ticks.By default the scheduler renders the time using the current culture time format.The fields which can be used in the template are: date - represents the major tick date..
major-time-header-template-handler String The template used to render the major ticks.By default the scheduler renders the time using the current culture time format.The fields which can be used in the template are: date - represents the major tick date..
major-time-header-template-id String The template used to render the major ticks.By default the scheduler renders the time using the current culture time format.The fields which can be used in the template are: date - represents the major tick date..
major-time-header-template-view IHtmlContent The template used to render the major ticks.By default the scheduler renders the time using the current culture time format.The fields which can be used in the template are: date - represents the major tick date..
max DateTime Constraints the maximum date which can be selected via the scheduler navigation.
min DateTime Constraints the minimum date which can be selected via the scheduler navigation.
minor-tick-count Int32 The number of time slots to display per major tick.
minor-time-header-template String The template used to render the minor ticks.By default the scheduler renders a "&nbsp;".The fields which can be used in the template are: date - represents the major tick date..
minor-time-header-template-handler String The template used to render the minor ticks.By default the scheduler renders a "&nbsp;".The fields which can be used in the template are: date - represents the major tick date..
minor-time-header-template-id String The template used to render the minor ticks.By default the scheduler renders a "&nbsp;".The fields which can be used in the template are: date - represents the major tick date..
minor-time-header-template-view IHtmlContent The template used to render the minor ticks.By default the scheduler renders a "&nbsp;".The fields which can be used in the template are: date - represents the major tick date..
mobile MobileMode Defines the mobile modes supported by Kendo UI Scheduler for ASP.NET MVC
on-add String Fired when a new event is about to be added.The event handler function context (available via the this keyword) will be set to the widget instance.
on-cancel String Fired when the user cancels editing by clicking the "cancel" button.The event handler function context (available via the this keyword) will be set to the widget instance.
on-change String Fired when the user selects a cell or event in the scheduler.The event handler function context (available via the this keyword) will be set to the widget instance.
on-data-binding String Fired before the widget binds to its data source.The event handler function context (available via the this keyword) will be set to the widget instance.
on-data-bound String Fired when the widget is bound to data from its data source.The event handler function context (available via the this keyword) will be set to the widget instance.
on-edit String Fired when the user opens a scheduler event in edit mode by or creates a new event.The event handler function context (available via the this keyword) will be set to the widget instance.
on-move String Fired when the user starts to drag an event.The event handler function context (available via the this keyword) will be set to the widget instance.
on-move-end String Fired when the user stops moving an event.The event handler function context (available via the this keyword) will be set to the widget instance.
on-move-start String Fired when the user starts to drag an event.The event handler function context (available via the this keyword) will be set to the widget instance.
on-navigate String Fired when the user changes the selected date, selected Scheduler view or switches between show full day and show business hours.The event handler function context (available via the this keyword) will be set to the widget instance.
on-pdf-export String Fired when the user clicks the "Export to PDF" toolbar button.
on-remove String Fired when the user performs "destroy" action.The event handler function context (available via the this keyword) will be set to the widget instance.
on-resize String Fired when the user starts to resize an event.The event handler function context (available via the this keyword) will be set to the widget instance.
on-resize-end String Fired when the user releases the mouse after resizing an event.The event handler function context (available via the this keyword) will be set to the widget instance.
on-resize-start String Fired when the user starts to resize an event.The event handler function context (available via the this keyword) will be set to the widget instance.
on-save String Fired when the user saves a scheduler event by clicking the "save" button.The event handler function context (available via the this keyword) will be set to the widget instance.
sanitize-id Boolean
script-attributes IDictionary<String,Object>
selectable Boolean If set to true the user would be able to select scheduler cells and events. By default selection is disabled.
show-work-hours Boolean If set to true the view will be initially shown in business hours mode. By default view is displayed in full day mode.
snap Boolean If set to true the scheduler will snap events to the nearest slot during dragging (resizing or moving). Set it to false to allow free moving and resizing of events.
start-time DateTime The start time of the week and day views. The scheduler will display events starting after the startTime.
timezone String The timezone which the scheduler will use to display the scheduler appointment dates. By default the current system timezone is used. This is an acceptable default when the scheduler widget is bound to local array of events. It is advisable to specify a timezone if the scheduler is bound to a remote service. That way all users would see the same dates and times no matter their configured system timezone.The complete list of the supported timezones is available in the List of IANA time zones Wikipedia page.
width Double The width of the widget. Numeric values are treated as pixels.
work-day-end DateTime Sets the end of the work day when the "Show business hours" button is clicked.
work-days Int32[] Sets the working days (index based).
work-day-start DateTime Sets the start of the work day when the "Show business hours" button is clicked.
work-week-end Int32 The end of working week (index based).
work-week-start Int32 The start of working week (index based).
In this article
Related articles
Not finding the help you need?