Defines the fluent interface for configuring the SchedulerTimelineViewBase.
Definition
Namespace:Kendo.Mvc.UI.Fluent
Assembly:Kendo.Mvc.dll
Type Parameters:
TView
TTimelineViewBuilder
Syntax:
public abstract class SchedulerTimelineViewBuilderBase<TView, TTimelineViewBuilder> : SchedulerBaseViewBuilder<TView, TTimelineViewBuilder> where TView : SchedulerTimelineViewBase where TTimelineViewBuilder : SchedulerTimelineViewBuilderBase<TView, TTimelineViewBuilder>
Inheritance: objectSchedulerBaseViewBuilder<TView, TTimelineViewBuilder>SchedulerTimelineViewBuilderBase<TView, TTimelineViewBuilder>
Derived Classes:
Inherited Members
Constructors
public SchedulerTimelineViewBuilderBase(TView resource)
Methods
The width of the scheduler timeline view column.
public TTimelineViewBuilder ColumnWidth(int columnWidth)
The columnWidth
Returns:TTimelineViewBuilder
Defines the template used to render the date header cells. The option is supported for Day, Week, WorkWeek, and Timeline views. By default the Scheduler renders the date using a custom date format - "ddd M/dd". The "ddd" specifier (the abbreviated name of the week day), 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 TTimelineViewBuilder DateHeaderTemplate(string dateHeaderTemplate)
The value that configures the template content.
Returns:TTimelineViewBuilder
Defines the template used to render the date header cells. The option is supported for Day, Week, WorkWeek, and Timeline views. By default the Scheduler renders the date using a custom date format - "ddd M/dd". The "ddd" specifier (the abbreviated name of the week day), 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 TTimelineViewBuilder DateHeaderTemplate<TModel>(TemplateBuilder<TModel> template)
A Template component that configures the template.
Returns:TTimelineViewBuilder
Defines the template used to render the date header cells. The option is supported for Day, Week, WorkWeek, and Timeline views. By default the Scheduler renders the date using a custom date format - "ddd M/dd". The "ddd" specifier (the abbreviated name of the week day), 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 TTimelineViewBuilder DateHeaderTemplateHandler(string dateHeaderTemplate)
The JavaScript function that returns the template.
Returns:TTimelineViewBuilder
Defines the template used to render the date header cells. The option is supported for Day, Week, WorkWeek, and Timeline views. By default the Scheduler renders the date using a custom date format - "ddd M/dd". The "ddd" specifier (the abbreviated name of the week day), 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 TTimelineViewBuilder DateHeaderTemplateId(string dateHeaderTemplateId)
The "id" attribute of the external Kendo UI Template.
Returns:TTimelineViewBuilder
Defines the template used to render the date header cells. The option is supported for Day, Week, WorkWeek, and Timeline views. By default the Scheduler renders the date using a custom date format - "ddd M/dd". The "ddd" specifier (the abbreviated name of the week day), 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 TTimelineViewBuilder DateHeaderTemplateView(MvcHtmlString dateHeaderTemplate)
The Razor View that contains the template.
Returns:TTimelineViewBuilder
The end time of the view. The scheduler will display events ending before the endTime.
public TTimelineViewBuilder EndTime(DateTime endTime)
The endTime
Returns:TTimelineViewBuilder
The height of the scheduler event rendered in timeline view.
public TTimelineViewBuilder EventHeight(int eventHeight)
The eventHeight
Returns:TTimelineViewBuilder
If set to false the scheduler will not display the "footer" area. Default value is true.
public TTimelineViewBuilder Footer(bool showFooter)
The footer
Returns:TTimelineViewBuilder
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 TTimelineViewBuilder GroupHeaderTemplate(string groupHeaderTemplate)
The value that configures the template content.
Returns:TTimelineViewBuilder
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 TTimelineViewBuilder GroupHeaderTemplate<TModel>(TemplateBuilder<TModel> template)
A Template component that configures the template.
Returns:TTimelineViewBuilder
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 TTimelineViewBuilder GroupHeaderTemplateHandler(string groupHeaderTemplate)
The JavaScript function that returns the template.
Returns:TTimelineViewBuilder
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 TTimelineViewBuilder GroupHeaderTemplateId(string groupHeaderTemplateId)
The "id" attribute of the external Kendo UI Template.
Returns:TTimelineViewBuilder
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 TTimelineViewBuilder GroupHeaderTemplateView(MvcHtmlString groupHeaderTemplate)
The Razor View that contains the template.
Returns:TTimelineViewBuilder
The number of minutes represented by a major tick.
public TTimelineViewBuilder MajorTick(int majorTick)
The majorTick
Returns:TTimelineViewBuilder
Defines the template used to render the major ticks. The option is supported for Day, Week, WorkWeek, and Timeline views. 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 TTimelineViewBuilder MajorTimeHeaderTemplate(string majorTimeHeaderTemplate)
The value that configures the template content.
Returns:TTimelineViewBuilder
Defines the template used to render the major ticks. The option is supported for Day, Week, WorkWeek, and Timeline views. 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 TTimelineViewBuilder MajorTimeHeaderTemplate<TModel>(TemplateBuilder<TModel> template)
A Template component that configures the template.
Returns:TTimelineViewBuilder
Defines the template used to render the major ticks. The option is supported for Day, Week, WorkWeek, and Timeline views. 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 TTimelineViewBuilder MajorTimeHeaderTemplateHandler(string majorTimeHeaderTemplate)
The JavaScript function that returns the template.
Returns:TTimelineViewBuilder
Defines the template used to render the major ticks. The option is supported for Day, Week, WorkWeek, and Timeline views. 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 TTimelineViewBuilder MajorTimeHeaderTemplateId(string majorTimeHeaderTemplateId)
The "id" attribute of the external Kendo UI Template.
Returns:TTimelineViewBuilder
Defines the template used to render the major ticks. The option is supported for Day, Week, WorkWeek, and Timeline views. 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 TTimelineViewBuilder MajorTimeHeaderTemplateView(MvcHtmlString majorTimeHeaderTemplate)
The Razor View that contains the template.
Returns:TTimelineViewBuilder
The number of time slots to display per major tick.
public TTimelineViewBuilder MinorTickCount(int minorTickCount)
The minorTickCount
Returns:TTimelineViewBuilder
If set the view will be initially shown in business hours mode.
public TTimelineViewBuilder ShowWorkHours()
TTimelineViewBuilder
If set to true the view will be initially shown in business hours mode.
public TTimelineViewBuilder ShowWorkHours(bool value)
TTimelineViewBuilder
Defines the template used to render the time slot cells. The option is supported for Day, Week, WorkWeek, and Timeline views. The available fields in the template are:
- date: Represents the slot date and time.
- resources(): Returns the relevant resources for the current slot.
public TTimelineViewBuilder SlotTemplate(string slotTemplate)
The value that configures the template content.
Returns:TTimelineViewBuilder
Defines the template used to render the time slot cells. The option is supported for Day, Week, WorkWeek, and Timeline views. The available fields in the template are:
- date: Represents the slot date and time.
- resources(): Returns the relevant resources for the current slot.
public TTimelineViewBuilder SlotTemplate<TModel>(TemplateBuilder<TModel> template)
A Template component that configures the template.
Returns:TTimelineViewBuilder
Defines the template used to render the time slot cells. The option is supported for Day, Week, WorkWeek, and Timeline views. The available fields in the template are:
- date: Represents the slot date and time.
- resources(): Returns the relevant resources for the current slot.
public TTimelineViewBuilder SlotTemplateHandler(string slotTemplate)
The JavaScript function that returns the template.
Returns:TTimelineViewBuilder
Defines the template used to render the time slot cells. The option is supported for Day, Week, WorkWeek, and Timeline views. The available fields in the template are:
- date: Represents the slot date and time.
- resources(): Returns the relevant resources for the current slot.
public TTimelineViewBuilder SlotTemplateId(string slotTemplateId)
The "id" attribute of the external Kendo UI Template.
Returns:TTimelineViewBuilder
Defines the template used to render the time slot cells. The option is supported for Day, Week, WorkWeek, and Timeline views. The available fields in the template are:
- date: Represents the slot date and time.
- resources(): Returns the relevant resources for the current slot.
public TTimelineViewBuilder SlotTemplateView(MvcHtmlString slotTemplate)
The Razor View that contains the template.
Returns:TTimelineViewBuilder
The start time of the view. The scheduler will display events starting after the startTime.
public TTimelineViewBuilder StartTime(DateTime startTime)
The startTime
Returns:TTimelineViewBuilder
If set to false the scheduler will not display the "WorkDayCommand" button. Default value is true.
public TTimelineViewBuilder WorkDayCommand(bool showWorkDayCommand)
The showWorkDayCommand
Returns:TTimelineViewBuilder
The end time of the business hours. The scheduler will display events before the workDayEnd if "WorkDayCommand" button is clicked.
public TTimelineViewBuilder WorkDayEnd(DateTime workDayEnd)
The WorkDayEnd
Returns:TTimelineViewBuilder
The end time of the business hours. The scheduler will display events before the workDayEnd if "WorkDayCommand" button is clicked.
Sets the working days (index based).
public TTimelineViewBuilder WorkDays(int[] workDays)
The indices of the days of the week
Returns:TTimelineViewBuilder
The start time of the business hours. The scheduler will display events after the workDayStart if "WorkDayCommand" button is clicked.
public TTimelineViewBuilder WorkDayStart(DateTime workDayStart)
The WorkDayStart
Returns:TTimelineViewBuilder
The start time of the business hours. The scheduler will display events after the workDayStart if "WorkDayCommand" button is clicked.
Sets the end day of work week by index.
public TTimelineViewBuilder WorkWeekEnd(int workWeekEndDay)
The workWeekEndDay
Returns:TTimelineViewBuilder
Sets the start day of work week by index.
public TTimelineViewBuilder WorkWeekStart(int workWeekStartDay)
The workWeekStartDay
Returns:TTimelineViewBuilder