Class Schedule

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

Schedule

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	The default value is null

ActionComplete

Triggers on successful completion of the scheduler actions.

Declaration

public string ActionComplete { get; set; }

Property Value

Type	Description
System.String	The default value is null

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	The default value is null

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.

Declaration

public double AgendaDaysCount { get; set; }

Property Value

Type	Description
System.Double	The default value is 7

AllowClipboard

Enables clipboard functionality for appointments, allowing them to be copied using keyboard shortcuts and pasted onto the Scheduler. When set to true, users can use keyboard shortcuts to cut, copy appointments and paste them into different time slots or calendars.

Declaration

public bool AllowClipboard { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

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.

Declaration

public bool AllowDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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	The default value is false

AllowKeyboardInteraction

When set to true, allows the keyboard interaction to take place on Schedule.

Declaration

public bool AllowKeyboardInteraction { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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	The default value is true

AllowMultiDrag

This property helps to drag the multiple selected events. By default, it is set to false.

Declaration

public bool AllowMultiDrag { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

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	The default value is true

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

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.

Declaration

public bool AllowResizing { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

AllowSwiping

Defines whether to enable date navigations via swipe in touch devices or not.

Declaration

public bool AllowSwiping { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

BeforePaste

Triggers once when pasting an event on the scheduler.

Declaration

public string BeforePaste { get; set; }

Property Value

Type	Description
System.String	The default value is null

BeforePrint

Triggers when the print event is called.

Declaration

public string BeforePrint { get; set; }

Property Value

Type	Description
System.String	The default value is null

CalendarMode

It allows the Scheduler to display in other calendar modes. By default, Scheduler is displayed in Gregorian calendar mode.

Declaration

public CalendarType CalendarMode { get; set; }

Property Value

Type	Description
CalendarType	The default value is CalendarType.Gregorian

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	The default value is null

CellDoubleClick

Triggers when the scheduler cells are double clicked.

Declaration

public string CellDoubleClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

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 fields accessible via template are as follows. date: Returns the date of the cell. groupIndex: Returns the group index of the cell. type: Returns the type of the work cell.

Declaration

public string CellTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

Created

Triggers after the scheduler component is created.

Declaration

public string Created { get; set; }

Property Value

Type	Description
System.String	The default value is null

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.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The default value is null

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: 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 CurrentView { get; set; }

Property Value

Type	Description
View	The default value is View.Week

DataBinding

Triggers before the data binds to the scheduler.

Declaration

public string DataBinding { get; set; }

Property Value

Type	Description
System.String	The default value is null

DataBound

Triggers once the event data is bound to the scheduler.

Declaration

public string DataBound { 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.

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.

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 day header cells. 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

Destroyed

Triggers when the scheduler component is destroyed.

Declaration

public string Destroyed { get; set; }

Property Value

Type	Description
System.String	The default value is null

Drag

Triggers when an appointment is being in a dragged state.

Declaration

public string Drag { get; set; }

Property Value

Type	Description
System.String	The default value is null

DragStart

Triggers when an appointment is started to drag.

Declaration

public string DragStart { get; set; }

Property Value

Type	Description
System.String	The default value is null

DragStop

Triggers when the dragging of appointment is stopped.

Declaration

public string DragStop { get; set; }

Property Value

Type	Description
System.String	The default value is null

EditorFooterTemplate

The template option to render the customized footer of the editor window.

Declaration

public string EditorFooterTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

EditorHeaderTemplate

The template option to render the customized header of the editor window.

Declaration

public string EditorHeaderTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

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.

Declaration

public string EditorTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

EnableAdaptiveUI

When set to true, the header view navigations are listed under the popup and if we enable resource grouping, the compact view will be enabled.

Declaration

public bool EnableAdaptiveUI { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableAllDayScroll

When set to true, If valid, the scroll on the all day row is activated when the all day row height reaches the max height when the all day row is expanded.

Declaration

public bool EnableAllDayScroll { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableHtmlSanitizer

Specifies whether to enable the rendering of untrusted HTML values in the Schedule component. When this property is enabled, the component will sanitize any suspected untrusted strings and scripts before rendering them.

Declaration

public bool EnableHtmlSanitizer { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnablePersistence

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

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableRecurrenceValidation

The recurrence validation will be done by default. When this property is set to false, the recurrence validation will be skipped.

Declaration

public bool EnableRecurrenceValidation { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { 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"

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	The default value is null

EventDoubleClick

Triggers when the events are double clicked or on double tapping the events on the desktop devices.

Declaration

public string EventDoubleClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

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.

Declaration

public string EventDragArea { get; set; }

Property Value

Type	Description
System.String	The default value is null

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	The default value is null

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.

Declaration

public ScheduleEventSettings EventSettings { get; set; }

Property Value

Type	Description
ScheduleEventSettings	The default value is null

ExcelExport

Triggers before the Excel export process begins.

Declaration

public string ExcelExport { 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 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.

Declaration

public ScheduleGroup Group { get; set; }

Property Value

Type	Description
ScheduleGroup	The default value is null

HeaderIndentTemplate

Template option to customize the header indent bar. Here, the template accepts either the string or HTMLElement as template design and then the parsed design is displayed onto the header indent cell.

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 List<ScheduleHeaderRow> HeaderRows { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ScheduleHeaderRow>	The default value is null

Height

Sets the height of the Schedule component, accepting both string and number values.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	The default value is "auto"

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.

Declaration

public bool HideEmptyAgendaDays { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Hover

Triggers when the scheduler elements are hovered.

Declaration

public string Hover { get; set; }

Property Value

Type	Description
System.String	The default value is null

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
System.Object

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	The default value is ""

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	The default value is null

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	The default value is null

MonthHeaderTemplate

It accepts either the string or HTMLElement as template design content and parse it appropriately before displaying it onto the month header cells. 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

MoreEventsClick

Triggers when the more events indicator are clicked.

Declaration

public string MoreEventsClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

Navigating

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

Declaration

public string Navigating { get; set; }

Property Value

Type	Description
System.String	The default value is null

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

PopupClose

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

Declaration

public string PopupClose { get; set; }

Property Value

Type	Description
System.String	The default value is null

PopupOpen

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

Declaration

public string PopupOpen { get; set; }

Property Value

Type	Description
System.String	The default value is null

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	The default value is false

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.

Declaration

public ScheduleQuickInfoTemplates QuickInfoTemplates { get; set; }

Property Value

Type	Description
ScheduleQuickInfoTemplates	The default value is null

Readonly

When set to true, makes the Schedule to render in a read only mode. No CRUD actions will be allowed at this time.

Declaration

public bool Readonly { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

RenderCell

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

Declaration

public string RenderCell { get; set; }

Property Value

Type	Description
System.String	The default value is null

ResizeStart

Triggers when an appointment is started to resize.

Declaration

public string ResizeStart { get; set; }

Property Value

Type	Description
System.String	The default value is null

ResizeStop

Triggers when the resizing of appointment is stopped.

Declaration

public string ResizeStop { get; set; }

Property Value

Type	Description
System.String	The default value is null

Resizing

Triggers when an appointment is being in a resizing action.

Declaration

public string Resizing { get; set; }

Property Value

Type	Description
System.String	The default value is null

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.

Declaration

public string ResourceHeaderTemplate { get; set; }

Property Value

Type	Description
System.String	The default value is null

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.

Declaration

public List<ScheduleResource> Resources { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ScheduleResource>	The default value is null

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.

Declaration

public bool RowAutoHeight { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Select

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

Declaration

public string Select { get; set; }

Property Value

Type	Description
System.String	The default value is null

SelectedDate

To mark the active (current) date on the Schedule, selectedDate property can be defined. Usually, it defaults to the current System date.

Declaration

public object SelectedDate { get; set; }

Property Value

Type	Description
System.Object	The default value is null

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.

Declaration

public bool ShowHeaderBar { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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.

Declaration

public bool ShowQuickInfo { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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.

Declaration

public bool ShowTimeIndicator { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

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.

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. By default, it is set to false.

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 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.

Declaration

public ScheduleTimeScale TimeScale { get; set; }

Property Value

Type	Description
ScheduleTimeScale	The default value is null

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.

Declaration

public string Timezone { get; set; }

Property Value

Type	Description
System.String	The default value is null

TimezoneDataSource

Allows to define the collection of timezone items in the Schedule. Only the items bound to this property get listed out in the timezone dropdown of the appointment window.

Declaration

public object TimezoneDataSource { get; set; }

Property Value

Type	Description
System.Object	The default value is null

ToolbarItems

To render the custom toolbar items, the toolbarItems property can be used. It contains built-in and custom toolbar items. To avail the built-in toolbar items, the below string values are assigned to the name property of the ToolbarItemModel. Previous: Schedule component navigates to the previous date from the current date. Next: Schedule component navigates to the next date from the current date. Today: Schedule component navigates to the current date from any date. Views: Schedule component render the defined view options in the toolbar. If view option is not defined, then it will render default view options in the Schedule. DateRangeText: Schedule component displays the current date text range. NewEvent: Schedule component render the icon to add a new event.

Declaration

public List<ScheduleToolbarItem> ToolbarItems { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ScheduleToolbarItem>	The default value is null

TooltipOpen

Triggers before the tooltip is rendered.

Declaration

public string TooltipOpen { get; set; }

Property Value

Type	Description
System.String	The default value is null

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.

Declaration

public object Views { get; set; }

Property Value

Type	Description
System.Object	The default value is null

VirtualScrollStart

Triggers when the scroll action is started. This event triggers only when allowVirtualScrolling or enableLazyLoading properties are enabled along with resource grouping.

Declaration

public string VirtualScrollStart { get; set; }

Property Value

Type	Description
System.String	The default value is null

VirtualScrollStop

Triggers when the scroll action is stopped. This event triggers only when allowVirtualScrolling or enableLazyLoading properties are enabled along with resource grouping.

Declaration

public string VirtualScrollStop { get; set; }

Property Value

Type	Description
System.String	The default value is null

WeekRule

It allows the Scheduler to display week numbers based on following available week options. The week option specified in this property will be initially loaded on the schedule. FirstDay: Denotes that the first week of the year starts on the first day of the year and ends before the following designated first day of the week. FirstFourDayWeek:Denotes that the first week of the year is the first week with four or more days before the designated first day of the week. FirstFullWeek: Denotes that the first week of the year begins on the first occurrence of the designated first day of the week on or after the first day of the year.

Declaration

public WeekRule WeekRule { get; set; }

Property Value

Type	Description
WeekRule	The default value is WeekRule.FirstDay

Width

Sets the width of the Schedule component, accepting both string and number values.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The default value is "auto"

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

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.

Declaration

public ScheduleWorkHours WorkHours { get; set; }

Property Value

Type	Description
ScheduleWorkHours	The default value is null