Class ScheduleView

Inheritance
System.Object
Syncfusion.EJ2.EJTagHelper
ScheduleView
Namespace: Syncfusion.EJ2.Schedule
Assembly: Syncfusion.EJ2.dll
Syntax
public class ScheduleView : EJTagHelper

Constructors

ScheduleView()

Declaration
public ScheduleView()

Properties

AllowOverlap

Specifies whether overlapping appointments are allowed within the same time slot in the Scheduler.

Declaration
public bool AllowOverlap { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

AllowVirtualScrolling

It is used to allow or disallow the virtual scrolling functionality.

Declaration
public bool AllowVirtualScrolling { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

CellHeaderTemplate

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 string CellHeaderTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

CellTemplate

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 string CellTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

DateFormat

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 string DateFormat { get; set; }
Property Value
Type Description
System.String

The default value is null

DateHeaderTemplate

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 string DateHeaderTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

DateRangeTemplate

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 string DateRangeTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

DayHeaderTemplate

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 string DayHeaderTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

DisplayDate

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.

Declaration
public object DisplayDate { get; set; }
Property Value
Type Description
System.Object

The default value is null

DisplayName

When the same view is customized with different intervals, this property allows the user to set different display name for those views.

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
System.String

The default value is null

EnableLazyLoading

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 bool EnableLazyLoading { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

EndHour

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 string EndHour { get; set; }
Property Value
Type Description
System.String

The default value is "24:00"

EventTemplate

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 string EventTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

FirstDayOfWeek

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 double FirstDayOfWeek { get; set; }
Property Value
Type Description
System.Double

The default value is 0

FirstMonthOfYear

This property helps render the year view customized months. By default, it is set to 0.

Declaration
public double FirstMonthOfYear { get; set; }
Property Value
Type Description
System.Double

The default value is 0

Group

Allows to set different resource grouping options on all available schedule view modes.

Declaration
public ScheduleGroup Group { get; set; }
Property Value
Type Description
ScheduleGroup

The default value is null

HeaderIndentTemplate

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 string HeaderIndentTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

HeaderRows

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 object HeaderRows { get; set; }
Property Value
Type Description
System.Object

The default value is null

Interval

It accepts the number value denoting to include the number of days, weeks, workweeks or months on the defined view type.

Declaration
public double Interval { get; set; }
Property Value
Type Description
System.Double

The default value is 1

IsSelected

Declaration
public bool IsSelected { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

MaxEventsPerRow

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 double MaxEventsPerRow { get; set; }
Property Value
Type Description
System.Double

The default value is Double.NaN

MonthHeaderTemplate

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 string MonthHeaderTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

MonthsCount

This option allows the user to set the number of months count to be displayed on the Schedule.

Declaration
public int MonthsCount { get; set; }
Property Value
Type Description
System.Int32

The default value is 12

NumberOfWeeks

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.

Declaration
public int NumberOfWeeks { get; set; }
Property Value
Type Description
System.Int32

The default value is 0

Option

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 View Option { get; set; }
Property Value
Type Description
View

The default value is null

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 Orientation Orientation { get; set; }
Property Value
Type Description
Orientation

The default value is Syncfusion.EJ2.Schedule.Orientation.Horizontal

OverscanCount

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 double OverscanCount { get; set; }
Property Value
Type Description
System.Double

The default value is 3

Readonly

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 bool Readonly { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

ResourceHeaderTemplate

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 string ResourceHeaderTemplate { get; set; }
Property Value
Type Description
System.String

The default value is null

ShowWeekend

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 bool ShowWeekend { get; set; }
Property Value
Type Description
System.Boolean

The default value is true

ShowWeekNumber

When set to true, displays the week number of the current view date range.

Declaration
public bool ShowWeekNumber { get; set; }
Property Value
Type Description
System.Boolean

The default value is false

StartHour

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 string StartHour { get; set; }
Property Value
Type Description
System.String

The default value is "00:00"

TimeFormat

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.

Declaration
public string TimeFormat { get; set; }
Property Value
Type Description
System.String

The default value is null

TimeScale

Allows to set different timescale configuration on each applicable view modes such as day, week and work week.

Declaration
public ScheduleTimeScale TimeScale { get; set; }
Property Value
Type Description
ScheduleTimeScale

The default value is null

WorkDays

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 int[] WorkDays { get; set; }
Property Value
Type Description
System.Int32[]

The default value is null