Defines the fluent interface for configuring the Scheduler<TModel>.
Definition
Namespace:Kendo.Mvc.UI.Fluent
Assembly:Kendo.Mvc.dll
Type Parameters:
TModel
Syntax:
public class SchedulerBuilder<TModel> : WidgetBuilderBase<Scheduler<TModel>, SchedulerBuilder<TModel>>, IHtmlString where TModel : class, ISchedulerEvent
Inheritance: objectWidgetBuilderBase<Scheduler<TModel>, SchedulerBuilder<TModel>>SchedulerBuilder<TModel>
Implements:
Inherited Members
Constructors
Initializes a new instance of the SchedulerBuilder<TModel> class.
public SchedulerBuilder(Scheduler<TModel> component)
The component.
Methods
Defines the template used to render the "all day" Scheduler events. The available fields in the template are:
- description: The event description.
- end: The event end date.
- isAllDay: if "true", the event is all day.
- resources: The event resources collection.
- start: The event start date.
- title: The event title.
public SchedulerBuilder<TModel> AllDayEventTemplate(string allDayEventTemplate)
The value that configures the template content.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the "all day" Scheduler events. The available fields in the template are:
- description: The event description.
- end: The event end date.
- isAllDay: if "true", the event is all day.
- resources: The event resources collection.
- start: The event start date.
- title: The event title.
public SchedulerBuilder<TModel> AllDayEventTemplate<T>(TemplateBuilder<T> template)
A Template component that configures the template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the "all day" Scheduler events. The available fields in the template are:
- description: The event description.
- end: The event end date.
- isAllDay: if "true", the event is all day.
- resources: The event resources collection.
- start: The event start date.
- title: The event title.
public SchedulerBuilder<TModel> AllDayEventTemplateHandler(string allDayEventTemplate)
The JavaScript function that returns the template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the "all day" Scheduler events. The available fields in the template are:
- description: The event description.
- end: The event end date.
- isAllDay: if "true", the event is all day.
- resources: The event resources collection.
- start: The event start date.
- title: The event title.
public SchedulerBuilder<TModel> AllDayEventTemplateId(string allDayEventTemplateId)
The "id" attribute of the external Kendo UI Template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the "all day" Scheduler events. The available fields in the template are:
- description: The event description.
- end: The event end date.
- isAllDay: if "true", the event is all day.
- resources: The event resources collection.
- start: The event start date.
- title: The event title.
public SchedulerBuilder<TModel> AllDayEventTemplateView(MvcHtmlString allDayEventTemplate)
The Razor View that contains the template.
Returns:SchedulerBuilder<TModel>
If set to true the scheduler will display a slot for "all day" events.
public SchedulerBuilder<TModel> AllDaySlot(bool allDaySlot)
The allDaySlot.
Returns:SchedulerBuilder<TModel>
If set to false the initial binding will be prevented.
public SchedulerBuilder<TModel> AutoBind(bool autoBind)
The autoBind
Returns:SchedulerBuilder<TModel>
Binds the scheduler to a list of objects
public SchedulerBuilder<TModel> BindTo(IEnumerable<TModel> dataSource)
The data source.
Returns:SchedulerBuilder<TModel>
Sets the currentTimeMarker configuration of the scheduler.
public SchedulerBuilder<TModel> CurrentTimeMarker(Action<SchedulerCurrentTimeMarkerSettingsBuilder> configurator)
The lambda which configures the currentTimeMarker
Returns:SchedulerBuilder<TModel>
If set to false the "current time" marker would be disabled.
public SchedulerBuilder<TModel> CurrentTimeMarker(bool enabled)
The enabled
Returns:SchedulerBuilder<TModel>
Configures the DataSource options.
public SchedulerBuilder<TModel> DataSource(Action<SchedulerAjaxDataSourceBuilder<TModel>> configurator)
The DataSource configurator action.
Returns:SchedulerBuilder<TModel>
Configures the DataSource options.
public SchedulerBuilder<TModel> DataSource(string dataSourceId)
The DataSource name.
Returns:SchedulerBuilder<TModel>
The current date of the scheduler. Used to determine the period which is displayed by the widget.
public SchedulerBuilder<TModel> Date(DateTime date)
The Date
Returns:SchedulerBuilder<TModel>
Defines 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 weekday and will be localized based on the current Kendo UI culture. To control the day and month order, use a custom template. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> DateHeaderTemplate(string dateHeaderTemplate)
The value that configures the template content.
Returns:SchedulerBuilder<TModel>
Defines 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 weekday and will be localized based on the current Kendo UI culture. To control the day and month order, use a custom template. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> DateHeaderTemplate<T>(TemplateBuilder<TModel> template)
A Template component that configures the template.
Returns:SchedulerBuilder<TModel>
Defines 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 weekday and will be localized based on the current Kendo UI culture. To control the day and month order, use a custom template. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> DateHeaderTemplateHandler(string dateHeaderTemplate)
The JavaScript function that returns the template.
Returns:SchedulerBuilder<TModel>
Defines 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 weekday and will be localized based on the current Kendo UI culture. To control the day and month order, use a custom template. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> DateHeaderTemplateId(string dateHeaderTemplateId)
The "id" attribute of the external Kendo UI Template.
Returns:SchedulerBuilder<TModel>
Defines 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 weekday and will be localized based on the current Kendo UI culture. To control the day and month order, use a custom template. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> DateHeaderTemplateView(MvcHtmlString dateHeaderTemplate)
The Razor View that contains the template.
Returns:SchedulerBuilder<TModel>
Sets the editing configuration of the scheduler.
public SchedulerBuilder<TModel> Editable(Action<SchedulerEditableSettingsBuilder<TModel>> configurator)
The lambda which configures the editing
Returns:SchedulerBuilder<TModel>
If set to false the user would not be able to create new scheduler events and modify or delete existing ones.
public SchedulerBuilder<TModel> Editable(bool isEditable)
The isEditable
Returns:SchedulerBuilder<TModel>
The end time of the week and day views. The scheduler will display events ending before the endTime.
public SchedulerBuilder<TModel> EndTime(DateTime endTime)
The endTime.
Returns:SchedulerBuilder<TModel>
The end time of the week and day views. The scheduler will display events ending before the endTime.
public SchedulerBuilder<TModel> EndTime(int hours, int minutes, int seconds)
The hours
minutesintThe minutes
secondsintThe seconds
Returns:SchedulerBuilder<TModel>
Sets the events configuration of the scheduler.
public SchedulerBuilder<TModel> Events(Action<SchedulerEventBuilder> clientEventsAction)
The lambda which configures the scheduler events
Returns:SchedulerBuilder<TModel>
Defines the template used to render the Scheduler events. The available fields in the template are:
- description: The event description.
- end: The event end date.
- resources: The event resources.
- start: The event start date.
- title: The event title.
public SchedulerBuilder<TModel> EventTemplate(string eventTemplate)
The value that configures the template content.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the Scheduler events. The available fields in the template are:
- description: The event description.
- end: The event end date.
- resources: The event resources.
- start: The event start date.
- title: The event title.
public SchedulerBuilder<TModel> EventTemplate<T>(TemplateBuilder<T> template)
A Template component that configures the template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the Scheduler events. The available fields in the template are:
- description: The event description.
- end: The event end date.
- resources: The event resources.
- start: The event start date.
- title: The event title.
public SchedulerBuilder<TModel> EventTemplateHandler(string eventTemplate)
The JavaScript function that returns the template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the Scheduler events. The available fields in the template are:
- description: The event description.
- end: The event end date.
- resources: The event resources.
- start: The event start date.
- title: The event title.
public SchedulerBuilder<TModel> EventTemplateId(string eventTemplateId)
The "id" attribute of the external Kendo UI Template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the Scheduler events. The available fields in the template are:
- description: The event description.
- end: The event end date.
- resources: The event resources.
- start: The event start date.
- title: The event title.
public SchedulerBuilder<TModel> EventTemplateView(MvcHtmlString eventTemplate)
The Razor View that contains the template.
Returns:SchedulerBuilder<TModel>
If set to false the footer of the scheduler would not be displayed.
public SchedulerBuilder<TModel> Footer(Action<SchedulerFooterBuilder> configurator)
The configurator for the footer setting.
Returns:SchedulerBuilder<TModel>
If set to false the footer of the scheduler would not be displayed.
public SchedulerBuilder<TModel> Footer(bool enabled)
Enables or disables the footer option.
Returns:SchedulerBuilder<TModel>
Sets the resources grouping configuration of the scheduler.
public SchedulerBuilder<TModel> Group(Action<SchedulerGroupBuilder> configuration)
The lambda which configures the scheduler grouping
Returns:SchedulerBuilder<TModel>
Defines the template used to render the group headers of the Scheduler Day, Week, WorkWeek, and Timeline views. The available fields in the template are:
- text: The group text.
- color: The group color.
- value: The group value.
- field: The field of the event, which contains the resource id.
- title: The 'title' option of the resource.
- name: The 'name' option of the resource.
public SchedulerBuilder<TModel> GroupHeaderTemplate(string groupHeaderTemplate)
The value that configures the template content.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the group headers of the Scheduler Day, Week, WorkWeek, and Timeline views. The available fields in the template are:
- text: The group text.
- color: The group color.
- value: The group value.
- field: The field of the event, which contains the resource id.
- title: The 'title' option of the resource.
- name: The 'name' option of the resource.
public SchedulerBuilder<TModel> GroupHeaderTemplate<T>(TemplateBuilder<T> template)
A Template component that configures the template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the group headers of the Scheduler Day, Week, WorkWeek, and Timeline views. The available fields in the template are:
- text: The group text.
- color: The group color.
- value: The group value.
- field: The field of the event, which contains the resource id.
- title: The 'title' option of the resource.
- name: The 'name' option of the resource.
public SchedulerBuilder<TModel> GroupHeaderTemplateHandler(string groupHeaderTemplate)
The JavaScript function that returns the template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the group headers of the Scheduler Day, Week, WorkWeek, and Timeline views. The available fields in the template are:
- text: The group text.
- color: The group color.
- value: The group value.
- field: The field of the event, which contains the resource id.
- title: The 'title' option of the resource.
- name: The 'name' option of the resource.
public SchedulerBuilder<TModel> GroupHeaderTemplateId(string groupHeaderTemplateId)
The "id" attribute of the external Kendo UI Template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the group headers of the Scheduler Day, Week, WorkWeek, and Timeline views. The available fields in the template are:
- text: The group text.
- color: The group color.
- value: The group value.
- field: The field of the event, which contains the resource id.
- title: The 'title' option of the resource.
- name: The 'name' option of the resource.
public SchedulerBuilder<TModel> GroupHeaderTemplateView(MvcHtmlString groupHeaderTemplate)
The Razor View that contains the template.
Returns:SchedulerBuilder<TModel>
The height of the widget.
public SchedulerBuilder<TModel> Height(int height)
The height.
Returns:SchedulerBuilder<TModel>
The number of minutes represented by a major tick.
public SchedulerBuilder<TModel> MajorTick(int majorTick)
The majorTick
Returns:SchedulerBuilder<TModel>
Defines the template used to render the major ticks. By default, the Scheduler renders the time using the current culture time format. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> MajorTimeHeaderTemplate(string majorTimeHeaderTemplate)
The value that configures the template content.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the major ticks. By default, the Scheduler renders the time using the current culture time format. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> MajorTimeHeaderTemplate<T>(TemplateBuilder<T> template)
A Template component that configures the template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the major ticks. By default, the Scheduler renders the time using the current culture time format. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> MajorTimeHeaderTemplateHandler(string majorTimeHeaderTemplate)
The JavaScript function that returns the template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the major ticks. By default, the Scheduler renders the time using the current culture time format. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> MajorTimeHeaderTemplateId(string majorTimeHeaderTemplateId)
The "id" attribute of the external Kendo UI Template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the major ticks. By default, the Scheduler renders the time using the current culture time format. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> MajorTimeHeaderTemplateView(MvcHtmlString majorTimeHeaderTemplate)
The Razor View that contains the template.
Returns:SchedulerBuilder<TModel>
Constraints the maximum date which can be selected via the scheduler navigation.
public SchedulerBuilder<TModel> Max(DateTime date)
The max date
Returns:SchedulerBuilder<TModel>
Sets the messages of the scheduler.
public SchedulerBuilder<TModel> Messages(Action<SchedulerMessagesBuilder> addViewAction)
The lambda which configures the scheduler messages
Returns:SchedulerBuilder<TModel>
Constraints the minimum date which can be selected via the scheduler navigation.
public SchedulerBuilder<TModel> Min(DateTime date)
The min date
Returns:SchedulerBuilder<TModel>
The number of time slots to display per major tick.
public SchedulerBuilder<TModel> MinorTickCount(int minorTickCount)
The minorTickCount
Returns:SchedulerBuilder<TModel>
Defines the template used to render the minor ticks. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> MinorTimeHeaderTemplate(string minorTimeHeaderTemplate)
The value that configures the template content.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the minor ticks. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> MinorTimeHeaderTemplate<T>(TemplateBuilder<T> template)
A Template component that configures the template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the minor ticks. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> MinorTimeHeaderTemplateHandler(string value)
The JavaScript function that returns the template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the minor ticks. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> MinorTimeHeaderTemplateId(string minorTimeHeaderTemplateId)
The "id" attribute of the external Kendo UI Template.
Returns:SchedulerBuilder<TModel>
Defines the template used to render the minor ticks. The available field in the template is "date", which represents the major tick date.
public SchedulerBuilder<TModel> MinorTimeHeaderTemplateView(MvcHtmlString minorTimeHeaderTemplate)
The Razor View that contains the template.
Returns:SchedulerBuilder<TModel>
Enables the adaptive rendering when viewed on mobile browser
Used to determine if adaptive rendering should be used when viewed on mobile browser
public SchedulerBuilder<TModel> Mobile(MobileMode type)
SchedulerBuilder<TModel>
The settings for the ongoing events highlight. The highlight is disabled by default. If you need to turn it on, set this option to true, or use a configuration object with its nested options.
public SchedulerBuilder<TModel> OngoingEvents(Action<SchedulerOngoingEventsSettingsBuilder> configurator)
The configurator for the ongoingevents setting.
Returns:SchedulerBuilder<TModel>
The settings for the ongoing events highlight. The highlight is disabled by default. If you need to turn it on, set this option to true, or use a configuration object with its nested options.
public SchedulerBuilder<TModel> OngoingEvents(bool enabled)
SchedulerBuilder<TModel>
Configures the PDF export settings.
public SchedulerBuilder<TModel> Pdf(Action<PDFSettingsBuilder> configurator)
SchedulerBuilder<TModel>
The template used to render the recurrence trigger summary in the desktop event editor.The template data contains the following fields: rule—The parsed recurrence rule object. or recurrenceRule—The serialized recurrence rule string..
public SchedulerBuilder<TModel> RecurrenceRuleLabelTemplate(string value)
The value for RecurrenceRuleLabelTemplate
Returns:SchedulerBuilder<TModel>
Returns the current SchedulerBuilder<TModel> instance.
The template used to render the recurrence trigger summary in the desktop event editor.The template data contains the following fields: rule—The parsed recurrence rule object. or recurrenceRule—The serialized recurrence rule string..
public SchedulerBuilder<TModel> RecurrenceRuleLabelTemplate<T>(TemplateBuilder<T> template)
A Template component that configures the recurrencerulelabeltemplate.
Returns:SchedulerBuilder<TModel>
Returns the current SchedulerBuilder<TModel> instance.
The template used to render the recurrence trigger summary in the desktop event editor.The template data contains the following fields: rule—The parsed recurrence rule object. or recurrenceRule—The serialized recurrence rule string..
public SchedulerBuilder<TModel> RecurrenceRuleLabelTemplateHandler(string templateHandler)
The handler that returs the template for RecurrenceRuleLabelTemplate
Returns:SchedulerBuilder<TModel>
Returns the current SchedulerBuilder<TModel> instance.
The template used to render the recurrence trigger summary in the desktop event editor.The template data contains the following fields: rule—The parsed recurrence rule object. or recurrenceRule—The serialized recurrence rule string..
public SchedulerBuilder<TModel> RecurrenceRuleLabelTemplateId(string templateId)
The ID of the template element for RecurrenceRuleLabelTemplate
Returns:SchedulerBuilder<TModel>
Returns the current SchedulerBuilder<TModel> instance.
The template used to render the recurrence trigger summary in the desktop event editor.The template data contains the following fields: rule—The parsed recurrence rule object. or recurrenceRule—The serialized recurrence rule string..
public SchedulerBuilder<TModel> RecurrenceRuleLabelTemplateView(MvcHtmlString templateView)
The view that contains the template for RecurrenceRuleLabelTemplate
Returns:SchedulerBuilder<TModel>
Returns the current SchedulerBuilder<TModel> instance.
Sets the resources configuration of the scheduler.
public SchedulerBuilder<TModel> Resources(Action<SchedulerResourceFactory<TModel>> addResourceAction)
The lambda which configures the scheduler resources
Returns:SchedulerBuilder<TModel>
If set to true the scheduler will enable the selection
public SchedulerBuilder<TModel> Selectable(bool selectable)
The selectable.
Returns:SchedulerBuilder<TModel>
If set day and week views will be initially shown in business hours mode.
public SchedulerBuilder<TModel> ShowWorkHours()
SchedulerBuilder<TModel>
This options is applicable only to work week, week and day views
If set to true day and week views will be initially shown in business hours mode.
public SchedulerBuilder<TModel> ShowWorkHours(bool value)
SchedulerBuilder<TModel>
This options is applicable only to work week, week and day views
If set to false the events would not snap events to the nearest slot during dragging (resizing or moving). Set it to false to allow free moving and resizing of events.
public SchedulerBuilder<TModel> Snap(bool isSnapable)
The isSnapable
Returns:SchedulerBuilder<TModel>
The start time of the week and day views. The scheduler will display events starting after the startTime.
public SchedulerBuilder<TModel> StartTime(DateTime startTime)
The startTime.
Returns:SchedulerBuilder<TModel>
The start time of the week and day views. The scheduler will display events starting after the startTime.
public SchedulerBuilder<TModel> StartTime(int hours, int minutes, int seconds)
The hours
minutesintThe minutes
secondsintThe seconds
Returns:SchedulerBuilder<TModel>
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.
public SchedulerBuilder<TModel> Timezone(string timezone)
The timezone
Returns:SchedulerBuilder<TModel>
Adds PDF command to the toolbar.
public SchedulerBuilder<TModel> Toolbar(Action<SchedulerToolbarFactory<TModel>> addToolbarAction)
SchedulerBuilder<TModel>
Sets the views configuration of the scheduler.
public SchedulerBuilder<TModel> Views(Action<SchedulerViewFactory<TModel>> addViewAction)
The lambda which configures the scheduler views
Returns:SchedulerBuilder<TModel>
The width of the widget.
public SchedulerBuilder<TModel> Width(int width)
The width
Returns:SchedulerBuilder<TModel>
The end time of the business day. The scheduler will display events ending before the workDayEnd when the "Show Business Hours" button is pressed.
public SchedulerBuilder<TModel> WorkDayEnd(DateTime workDayEnd)
The workDayEnd.
Returns:SchedulerBuilder<TModel>
The end time of the business day. The scheduler will display events ending before the workDayEnd when the "Show Business Hours" button is pressed.
public SchedulerBuilder<TModel> WorkDayEnd(int hours, int minutes, int seconds)
The hours
minutesintThe minutes
secondsintThe seconds
Returns:SchedulerBuilder<TModel>
Sets the working days (index based).
public SchedulerBuilder<TModel> WorkDays(int[] workDays)
The indices of the days of the week
Returns:SchedulerBuilder<TModel>
The start time of the business day. The scheduler will display events starting after the workDayStart when the "Show Business Hours" button is pressed.
public SchedulerBuilder<TModel> WorkDayStart(DateTime workDayStart)
The workDayStart.
Returns:SchedulerBuilder<TModel>
The start time of the business day. The scheduler will display events starting after the workDayStart when the "Show Business Hours" button is pressed.
public SchedulerBuilder<TModel> WorkDayStart(int hours, int minutes, int seconds)
The hours
minutesintThe minutes
secondsintThe seconds
Returns:SchedulerBuilder<TModel>
Sets the end day of work week by index.
public SchedulerBuilder<TModel> WorkWeekEnd(int workWeekEndDay)
The workWeekEndDay
Returns:SchedulerBuilder<TModel>
Sets the start day of work week by index.
public SchedulerBuilder<TModel> WorkWeekStart(int workWeekStartDay)
The workWeekStartDay
Returns:SchedulerBuilder<TModel>