Class ScheduleViewBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
ScheduleViewBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class ScheduleViewBuilder : ControlBuilder
Constructors
ScheduleViewBuilder()
Declaration
public ScheduleViewBuilder()
ScheduleViewBuilder(List<ScheduleView>)
Declaration
public ScheduleViewBuilder(List<ScheduleView> collection)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<ScheduleView> |
collection |
|
Methods
Add()
Declaration
AllowOverlap(Boolean)
Specifies whether overlapping appointments are allowed within the same time slot in the Scheduler.
Declaration
public ScheduleViewBuilder AllowOverlap(bool allowOverlap)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowOverlap |
|
Returns
It is used to allow or disallow the virtual scrolling functionality.
Declaration
public ScheduleViewBuilder AllowVirtualScrolling(bool allowVirtualScrolling)
Parameters
| Type |
Name |
Description |
| System.Boolean |
allowVirtualScrolling |
|
Returns
It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto the
month date cells.
This template is only applicable for month view day cells.
Declaration
public ScheduleViewBuilder CellHeaderTemplate(string cellHeaderTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
cellHeaderTemplate |
|
Returns
CellTemplate(String)
The template option which is used to render the customized work cells on the Schedule. Here, the
template accepts either the string or HTMLElement as template design and then the parsed design is displayed onto the work cells.
The field accessible via template is date. It gets applied only to the view objects on which it is defined.
Declaration
public ScheduleViewBuilder CellTemplate(string cellTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
cellTemplate |
|
Returns
By default, Schedule follows the date-format as per the default culture assigned to it. It is also possible to manually set
specific date format by using the dateFormat property. The format of the date range label in the header bar depends on
the dateFormat value or else based on the locale assigned to the Schedule.
It gets applied only to the view objects on which it is defined.
Declaration
public ScheduleViewBuilder DateFormat(string dateFormat)
Parameters
| Type |
Name |
Description |
| System.String |
dateFormat |
|
Returns
It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto the
date header cells. The field that can be accessed via this template is date.
It gets applied only to the view objects on which it is defined.
Declaration
public ScheduleViewBuilder DateHeaderTemplate(string dateHeaderTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
dateHeaderTemplate |
|
Returns
DateRangeTemplate(String)
It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto the header date range.
Declaration
public ScheduleViewBuilder DateRangeTemplate(string dateRangeTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
dateRangeTemplate |
|
Returns
It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto the
Year view day cell header.
This template is only applicable for year view header cells.
Declaration
public ScheduleViewBuilder DayHeaderTemplate(string dayHeaderTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
dayHeaderTemplate |
|
Returns
DisplayDate(Object)
Specifies the starting week date at an initial rendering of month view. This property is only applicable for month view.
If this property value is not set, then the month view will be rendered from the first week of the month.
{% codeBlock src='schedule/displayDate/index.md' %}{% endcodeBlock %}
Declaration
public ScheduleViewBuilder DisplayDate(object displayDate)
Parameters
| Type |
Name |
Description |
| System.Object |
displayDate |
|
Returns
DisplayName(String)
When the same view is customized with different intervals, this property allows the user to set different display name
for those views.
Declaration
public ScheduleViewBuilder DisplayName(string displayName)
Parameters
| Type |
Name |
Description |
| System.String |
displayName |
|
Returns
EnableLazyLoading(Boolean)
Enables the lazy loading of events for scrolling actions only when the resources grouping property is enabled.
Lazy loading allows the scheduler to fetch the appointments dynamically during scroll actions for the currently rendered resource collection.
New event data is fetched on-demand as the user scrolls through the schedule content.
Declaration
public ScheduleViewBuilder EnableLazyLoading(bool enableLazyLoading)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableLazyLoading |
|
Returns
EndHour(String)
It is used to specify the end hour, at which the Schedule ends. It too accepts the time string in a short skeleton format.
Declaration
public ScheduleViewBuilder EndHour(string endHour)
Parameters
| Type |
Name |
Description |
| System.String |
endHour |
|
Returns
EventTemplate(String)
It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto
the event background. All the event fields mapped to Schedule from dataSource can be accessed within this template code.
It is similar to that of the template option available within the eventSettings property,
whereas it will get applied only on the events of the view to which it is currently being defined.
Declaration
public ScheduleViewBuilder EventTemplate(string eventTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
eventTemplate |
|
Returns
FirstDayOfWeek(Double)
This option allows the user to set the first day of a week on Schedule. It should be based on the locale set to it and each culture
defines its own first day of week values. If needed, the user can set it manually on his own by defining the value through
this property. It usually accepts the integer values, whereby 0 is always denoted as Sunday, 1 as Monday and so on.
Declaration
public ScheduleViewBuilder FirstDayOfWeek(double firstDayOfWeek)
Parameters
| Type |
Name |
Description |
| System.Double |
firstDayOfWeek |
|
Returns
FirstMonthOfYear(Double)
This property helps render the year view customized months.
By default, it is set to 0.
Declaration
public ScheduleViewBuilder FirstMonthOfYear(double firstMonthOfYear)
Parameters
| Type |
Name |
Description |
| System.Double |
firstMonthOfYear |
|
Returns
Group(ScheduleGroup)
Allows to set different resource grouping options on all available schedule view modes.
Declaration
public ScheduleViewBuilder Group(ScheduleGroup group)
Parameters
Returns
Group(Action<ScheduleGroupBuilder>)
Declaration
public ScheduleViewBuilder Group(Action<ScheduleGroupBuilder> group)
Parameters
Returns
The template option which is used to render the customized header indent cell on the schedule. Here, the
template accepts either the string or HTMLElement as template design and then the parsed design is displayed onto the header indent cell.
It gets applied only to the view objects on which it is defined.
Declaration
public ScheduleViewBuilder HeaderIndentTemplate(string headerIndentTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
headerIndentTemplate |
|
Returns
Allows defining the collection of custom header rows to display the year, month, week, date and hour label as an individual row
on the timeline view of the scheduler.
Declaration
public ScheduleViewBuilder HeaderRows(object headerRows)
Parameters
| Type |
Name |
Description |
| System.Object |
headerRows |
|
Returns
Interval(Double)
It accepts the number value denoting to include the number of days, weeks, workweeks or months on the defined view type.
Declaration
public ScheduleViewBuilder Interval(double interval)
Parameters
| Type |
Name |
Description |
| System.Double |
interval |
|
Returns
IsSelected(Boolean)
To denote whether the view name given on the option is active or not.
It acts similar to the currentView
property and defines the active view of Schedule.
Declaration
public ScheduleViewBuilder IsSelected(bool isSelected)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isSelected |
|
Returns
MaxEventsPerRow(Double)
Specifies the maximum number of events to be displayed in a single row.
This property is applicable when the 'rowAutoHeight' property is disabled.
This property is only applicable for the month view, timeline views, and timeline year view.
Declaration
public ScheduleViewBuilder MaxEventsPerRow(double maxEventsPerRow)
Parameters
| Type |
Name |
Description |
| System.Double |
maxEventsPerRow |
|
Returns
It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto the
Year view day cell header.
This template is only applicable for year view header cells.
Declaration
public ScheduleViewBuilder MonthHeaderTemplate(string monthHeaderTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
monthHeaderTemplate |
|
Returns
MonthsCount(Int32)
This option allows the user to set the number of months count to be displayed on the Schedule.
{% codeBlock src='schedule/monthsCount/index.md' %}{% endcodeBlock %}
Declaration
public ScheduleViewBuilder MonthsCount(int monthsCount)
Parameters
| Type |
Name |
Description |
| System.Int32 |
monthsCount |
|
Returns
NumberOfWeeks(Int32)
This property customizes the number of weeks that are shown in month view. By default, it shows all weeks in the current month.
Use displayDate property to customize the starting week of month.
{% codeBlock src='schedule/numberOfWeeks/index.md' %}{% endcodeBlock %}
Declaration
public ScheduleViewBuilder NumberOfWeeks(int numberOfWeeks)
Parameters
| Type |
Name |
Description |
| System.Int32 |
numberOfWeeks |
|
Returns
Option(View)
It accepts the schedule view name, based on which we can define with its related properties in a single object.
The applicable view names are,
Day - Denotes Day view of the scheduler.
Week - Denotes Week view of the scheduler.
WorkWeek - Denotes Work Week view of the scheduler.
Month - Denotes Month view of the scheduler.
Year - Denotes Year view of the scheduler.
Agenda - Denotes Agenda view of the scheduler.
MonthAgenda - Denotes Month Agenda view of the scheduler.
TimelineDay - Denotes Timeline Day view of the scheduler.
TimelineWeek - Denotes Timeline Week view of the scheduler.
TimelineWorkWeek - Denotes Timeline Work Week view of the scheduler.
TimelineMonth - Denotes Timeline Month view of the scheduler.
TimelineYear - Denotes Timeline Year view of the scheduler.
Declaration
public ScheduleViewBuilder Option(View option)
Parameters
| Type |
Name |
Description |
| View |
option |
|
Returns
Orientation(Orientation)
It is used to specify the year view rendering orientation on the schedule.
The applicable orientation values are,
Horizontal - Denotes the horizontal orientation of Timeline Year view.
Vertical - Denotes the vertical orientation of Timeline Year view.
Declaration
public ScheduleViewBuilder Orientation(Orientation orientation)
Parameters
Returns
OverscanCount(Double)
Specifies the number of additional rows or columns to render outside the visible area during virtual scrolling.
This property helps in achieving smoother scrolling by pre-loading data just outside the visible region.
Declaration
public ScheduleViewBuilder OverscanCount(double overscanCount)
Parameters
| Type |
Name |
Description |
| System.Double |
overscanCount |
|
Returns
ReadOnly(Boolean)
When set to true, displays a quick popup with cell or event details on single clicking over the cells or on events.
By default, it is set to true. It gets applied only to the view objects on which it is defined.
Declaration
public ScheduleViewBuilder ReadOnly(bool readOnly)
Parameters
| Type |
Name |
Description |
| System.Boolean |
readOnly |
|
Returns
The template option which is used to render the customized header cells on the schedule. Here, the
template accepts either the string or HTMLElement as template design and then the parsed design is displayed onto the header cells.
All the resource fields mapped within resources can be accessed within this template code.
It gets applied only to the view objects on which it is defined.
Declaration
public ScheduleViewBuilder ResourceHeaderTemplate(string resourceHeaderTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
resourceHeaderTemplate |
|
Returns
ShowWeekend(Boolean)
When set to false, it hides the weekend days of a week from the Schedule.
The days which are not defined in the working days collection are usually treated as weekend days.
Note: By default, this option is not applicable on Work Week view.
For example, if the working days are defined as [1, 2, 3, 4], then the remaining days of that week will be considered as the
weekend days and will be hidden on all the views.
Declaration
public ScheduleViewBuilder ShowWeekend(bool showWeekend)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showWeekend |
|
Returns
ShowWeekNumber(Boolean)
When set to true, displays the week number of the current view date range.
Declaration
public ScheduleViewBuilder ShowWeekNumber(bool showWeekNumber)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showWeekNumber |
|
Returns
StartHour(String)
It is used to specify the starting hour, from which the Schedule starts to display.
It accepts the time string in a short skeleton format and also, hides the time beyond the specified start time.
Declaration
public ScheduleViewBuilder StartHour(string startHour)
Parameters
| Type |
Name |
Description |
| System.String |
startHour |
|
Returns
By default, Schedule follows the time-format as per the default culture assigned to it.
It is also possible to manually set specific time format by using the timeFormat property.
{% codeBlock src='schedule/timeFormat/index.md' %}{% endcodeBlock %}
Declaration
public ScheduleViewBuilder TimeFormat(string timeFormat)
Parameters
| Type |
Name |
Description |
| System.String |
timeFormat |
|
Returns
TimeScale(ScheduleTimeScale)
Allows to set different timescale configuration on each applicable view modes such as day, week and work week.
Declaration
public ScheduleViewBuilder TimeScale(ScheduleTimeScale timeScale)
Parameters
Returns
TimeScale(Action<ScheduleTimeScaleBuilder>)
Declaration
public ScheduleViewBuilder TimeScale(Action<ScheduleTimeScaleBuilder> timeScale)
Parameters
Returns
WorkDays(Int32[])
It is used to set the working days on schedule. The only days that are defined in this collection will be rendered on the
workWeek view whereas on other views, it will display all the usual days and simply highlights the working days with different
shade.
Declaration
public ScheduleViewBuilder WorkDays(int[] workDays)
Parameters
| Type |
Name |
Description |
| System.Int32[] |
workDays |
|
Returns