Class Schedule

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

Constructors

Schedule()

Declaration
public Schedule()

Properties

ActionBegin

Triggers on beginning of every scheduler action.

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

ActionComplete

Triggers on successful completion of the scheduler actions.

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

ActionFailure

Triggers when a scheduler action gets failed or interrupted and an error information will be returned.

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

AgendaDaysCount

Sets the number of days to be displayed by default in Agenda View and in case of virtual scrolling, the number of days will be fetched on each scroll-end based on this count. {% codeBlock src='schedule/agendaDaysCount/index.md' %}{% endcodeBlock %}

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

AllowDragAndDrop

When set to true, allows the appointments to move over the time slots. When an appointment is dragged, both its start and end time tends to change simultaneously allowing it to reschedule the appointment on some other time. {% codeBlock src='schedule/allowDragAndDrop/index.md' %}{% endcodeBlock %}

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

AllowInline

This property helps user to add/edit the event in inline. By default, it is set to false.

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

AllowKeyboardInteraction

When set to true, allows the keyboard interaction to take place on Schedule. {% codeBlock src='schedule/allowKeyboardInteraction/index.md' %}{% endcodeBlock %}

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

AllowMultiCellSelection

This property helps user to allow/prevent the selection of multiple cells. By default, it is set to true.

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

AllowMultiRowSelection

This property helps user to allow/prevent the selection of multiple days(rows). By default, it is set to true.

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

AllowResizing

When set to true, allows the resizing of appointments. It allows the rescheduling of appointments either by changing the start or end time by dragging the event resize handlers. {% codeBlock src='schedule/allowResizing/index.md' %}{% endcodeBlock %}

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

CalendarMode

It allows the Scheduler to display in other calendar modes. By default, Scheduler is displayed in Gregorian calendar mode. {% codeBlock src='schedule/calendarMode/index.md' %}{% endcodeBlock %} To change the mode, you can set either Gregorian or Islamic as a value to this calendarMode property.

Declaration
public CalendarType CalendarMode { get; set; }
Property Value
Type Description
CalendarType

CellClick

Triggers when the scheduler cells are single clicked or on single tap on the same cells in mobile devices.

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

CellDoubleClick

Triggers when the scheduler cells are double clicked.

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

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

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 fields accessible via template are as follows. date groupIndex type {% codeBlock src='schedule/cellTemplate/index.md' %}{% endcodeBlock %}

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

ClassName

Declaration
protected override string ClassName { get; }
Property Value
Type Description
System.String
Overrides

Created

Triggers after the scheduler component is created.

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

CssClass

It is used to customize the Schedule which accepts custom CSS class names that defines specific user-defined styles and themes to be applied on the Schedule element. {% codeBlock src='schedule/cssClass/index.md' %}{% endcodeBlock %}

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

CurrentView

To set the active view on scheduler, the currentView property can be used and it usually accepts either of the following available view options. The view option specified in this property will be initially loaded on the schedule. Day Week WorkWeek Month Year Agenda MonthAgenda TimelineDay TimelineWeek TimelineWorkWeek TimelineMonth TimelineYear {% codeBlock src='schedule/currentView/index.md' %}{% endcodeBlock %}

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

DataBinding

Triggers before the data binds to the scheduler.

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

DataBound

Triggers once the event data is bound to the scheduler.

Declaration
public string DataBound { 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. {% codeBlock src='schedule/dateFormat/index.md' %}{% endcodeBlock %} 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.

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

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

Destroyed

Triggers when the scheduler component is destroyed.

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

Drag

Triggers when an appointment is being in a dragged state.

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

DragStart

Triggers when an appointment is started to drag.

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

DragStop

Triggers when the dragging of appointment is stopped.

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

EditorTemplate

The template option to render the customized editor window. The form elements defined within this template should be accompanied with e-field class, so as to fetch and process it from internally. {% codeBlock src='schedule/editorTemplate/index.md' %}{% endcodeBlock %}

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

EnablePersistence

Enable or disable persisting component's state between page reloads.

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

EnableRecurrenceValidation

The recurrence validation will be done by default When this property is set to false, the recurrence validation will be skipped. {% codeBlock src='schedule/enableRecurrenceValidation/index.md' %}{% endcodeBlock %}

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

EnableRtl

Enable or disable rendering component in right to left direction.

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

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

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

EventClick

Triggers when the events are single clicked or on single tapping the events on the mobile devices.

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

EventDragArea

It enables the external drag and drop support for appointments on scheduler, to be able to move them out of the scheduler layout. When the drag area is explicitly set with specific DOM element name, the appointments can be dragged anywhere within the specified drag area location. {% codeBlock src='schedule/eventDragArea/index.md' %}{% endcodeBlock %}

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

EventRendered

Triggers before each of the event getting rendered on the scheduler user interface.

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

EventSettings

Complete set of settings related to Schedule events to bind it to local or remote dataSource, map applicable database fields and other validation to be carried out on the available fields. {% codeBlock src='schedule/eventSettings/index.md' %}{% endcodeBlock %}

Declaration
public ScheduleEventSettings EventSettings { get; set; }
Property Value
Type Description
ScheduleEventSettings

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

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

Group

Allows defining the group related settings of multiple resources. When this property is non-empty, it means that the resources will be grouped on the schedule layout based on the provided resource names. {% codeBlock src='schedule/group/index.md' %}{% endcodeBlock %}

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

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

Declaration
public List<ScheduleHeaderRow> HeaderRows { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ScheduleHeaderRow>

Height

Sets the height of the Schedule component, accepting both string and number values. {% codeBlock src='schedule/height/index.md' %}{% endcodeBlock %} The string type includes either pixel or percentage values. When height is set with specific pixel value, then the Schedule will be rendered to that specified space. In case, if auto value is set, then the height of the Schedule gets auto-adjusted within the given container.

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

HideEmptyAgendaDays

The days which does not has even a single event to display will be hidden from the UI of Agenda View by default. When this property is set to false, the empty dates will also be displayed on the Schedule. {% codeBlock src='schedule/hideEmptyAgendaDays/index.md' %}{% endcodeBlock %}

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

Hover

Triggers when the scheduler elements are hovered.

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

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

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

IsFor

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

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

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

MaxDate

To define the maximum date on the Schedule, maxDate property can be defined. Usually, it defaults to the new Date(2099, 11, 31).

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

MinDate

To define the minimum date on the Schedule, minDate property can be defined. Usually, it defaults to the new Date(1900, 0, 1).

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

MoreEventsClick

Triggers when the more events indicator are clicked.

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

NameSpace

Declaration
protected override string NameSpace { get; }
Property Value
Type Description
System.String
Overrides

Navigating

Triggers before the date or view navigation takes place on scheduler.

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

PopupClose

Triggers before any of the scheduler popups close on the page.

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

PopupOpen

Triggers before any of the scheduler popups opens on the page.

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

QuickInfoOnSelectionEnd

This property helps to show quick popup after multiple cell selection. By default, it is set to false.

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

QuickInfoTemplates

The template option to customize the quick window. The three sections of the quick popup whereas the header, content, and footer can be easily customized with individual template option. {% codeBlock src='schedule/quickInfoTemplates/index.md' %}{% endcodeBlock %}

Declaration
public ScheduleQuickInfoTemplates QuickInfoTemplates { get; set; }
Property Value
Type Description
ScheduleQuickInfoTemplates

Readonly

When set to true, makes the Schedule to render in a read only mode. No CRUD actions will be allowed at this time. {% codeBlock src='schedule/readonly/index.md' %}{% endcodeBlock %}

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

RenderCell

Triggers before each element of the schedule rendering on the page.

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

ResizeStart

Triggers when an appointment is started to resize.

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

ResizeStop

Triggers when the resizing of appointment is stopped.

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

Resizing

Triggers when an appointment is being in a resizing action.

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

ResourceHeaderTemplate

Template option to customize the resource header bar. Here, the template accepts either the string or HTMLElement as template design and then the parsed design is displayed onto the resource header cells. The following can be accessible via template. resource - All the resource fields. resourceData - object collection of current resource. {% codeBlock src='schedule/resourceHeaderTemplate/index.md' %}{% endcodeBlock %}

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

Resources

Allows defining the collection of resources to be displayed on the Schedule. The resource collection needs to be defined with unique resource names to identify it along with the respective dataSource and field mapping options. {% codeBlock src='schedule/resources/index.md' %}{% endcodeBlock %}

Declaration
public List<ScheduleResource> Resources { get; set; }
Property Value
Type Description
System.Collections.Generic.List<ScheduleResource>

RowAutoHeight

when set to true, allows the height of the work-cells to adjust automatically based on the number of appointments present in those time ranges. {% codeBlock src='schedule/rowAutoHeight/index.md' %}{% endcodeBlock %}

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

Select

Triggers when multiple cells or events are selected on the Scheduler.

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

SelectedDate

To mark the active (current) date on the Schedule, selectedDate property can be defined. Usually, it defaults to the current System date. {% codeBlock src='schedule/selectedDate/index.md' %}{% endcodeBlock %}

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

ShowHeaderBar

When set to false, hides the header bar of the Schedule from UI. By default, the header bar holds the date and view navigation options, to which the user can add their own custom items onto it. {% codeBlock src='schedule/showHeaderBar/index.md' %}{% endcodeBlock %}

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

ShowQuickInfo

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

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

ShowTimeIndicator

When set to false, hides the current time indicator from the Schedule. Otherwise, it visually depicts the live current system time appropriately on the user interface. {% codeBlock src='schedule/showTimeIndicator/index.md' %}{% endcodeBlock %}

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

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. {% codeBlock src='schedule/showWeekend/index.md' %}{% endcodeBlock %} 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. By default, it is set to false. {% codeBlock src='schedule/showWeekNumber/index.md' %}{% endcodeBlock %}

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

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

TagName

Declaration
protected override string TagName { get; }
Property Value
Type Description
System.String
Overrides

TimeScale

Allows to set different time duration on Schedule along with the customized grid count. It also has template option to customize the time slots with required time values in its own format. {% codeBlock src='schedule/timeScale/index.md' %}{% endcodeBlock %}

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

Timezone

Schedule will be assigned with specific timezone, so as to display the events in it accordingly. By default, Schedule dates are processed with System timezone, as no timezone will be assigned specifically to the Schedule at the initial time. Whenever the Schedule is bound to remote data services, it is always recommended to set specific timezone to Schedule to make the events on it to display on the same time irrespective of the system timezone. It usually accepts the valid IANA timezone names. {% codeBlock src='schedule/timezone/index.md' %}{% endcodeBlock %}

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

Views

This property holds the views collection and its configurations. It accepts either the array of view names or the array of view objects that holds different configurations for each views. By default, Schedule displays all the views namely Day, Week, Work Week, Month and Agenda. Example for array of views: {% codeBlock src="schedule/view-api/index.ts" %}{% endcodeBlock %} Example for array of view objects: {% codeBlock src="schedule/view-api/array.ts" %}{% endcodeBlock %} {% codeBlock src='schedule/views/index.md' %}{% endcodeBlock %}

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

Width

Sets the width of the Schedule component, accepting both string and number values. {% codeBlock src='schedule/width/index.md' %}{% endcodeBlock %} The string value can be either pixel or percentage format. When set to auto, the Schedule width gets auto-adjusted and display its content related to the viewable screen size.

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

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

Declaration
public int[] WorkDays { get; set; }
Property Value
Type Description
System.Int32[]

WorkHours

The working hours should be highlighted on Schedule with different color shade and an additional option must be provided to highlight it or not. This functionality is handled through workHours property and the start work hour should be 9 AM by default and end work hour should point to 6 PM. The start and end working hours needs to be provided as Time value of short skeleton type. {% codeBlock src='schedule/workHours/index.md' %}{% endcodeBlock %}

Declaration
public ScheduleWorkHours WorkHours { get; set; }
Property Value
Type Description
ScheduleWorkHours