Class ScheduleView

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

Constructors

ScheduleView()

Declaration
public ScheduleView()

Properties

AllowVirtualScrolling

It is used to allow or disallow the virtual scrolling functionality on Agenda View. This is applicable only on Agenda view.

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

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

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

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

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

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

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. {% codeBlock src='schedule/displayDate/index.md' %}{% endcodeBlock %}

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

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

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

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

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

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

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

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

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

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

IsChild

Declaration
protected override bool IsChild { get; }
Property Value
Type Description
System.Boolean
Overrides

IsSelected

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

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

MonthsCount

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

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. {% codeBlock src='schedule/numberOfWeeks/index.md' %}{% endcodeBlock %}

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

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 Week WorkWeek Month Year Agenda MonthAgenda TimelineDay TimelineWeek TimelineWorkWeek TimelineMonth TimelineYear

Declaration
public View Option { get; set; }
Property Value
Type Description
View

Orientation

It is used to specify the year view rendering orientation on the schedule. The applicable orientation values are, Horizontal Vertical

Declaration
public Orientation Orientation { get; set; }
Property Value
Type Description
Orientation

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

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

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

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

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

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. {% codeBlock src='schedule/timeFormat/index.md' %}{% endcodeBlock %}

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

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

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[]