Class Schedule
Inheritance
System.Object
Schedule
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Syncfusion.EJ2.dll
Syntax
public class Schedule : EJTagHelper
Constructors
Schedule()
Declaration
Properties
ActionBegin
Triggers on beginning of every scheduler action.
{% codeBlock src='schedule/actionBegin/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("actionBegin")]
public string ActionBegin { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ActionComplete
Triggers on successful completion of the scheduler actions.
{% codeBlock src='schedule/actionComplete/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("actionComplete")]
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.
{% codeBlock src='schedule/actionFailure/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("actionFailure")]
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
[HtmlAttributeName("agendaDaysCount")]
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
[HtmlAttributeName("allowDragAndDrop")]
public bool AllowDragAndDrop { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AllowInline
This property helps user to add/edit the event in inline.
{% codeBlock src='schedule/allowInline/index.md' %}{% endcodeBlock %}
By default, it is set to false.
Declaration
[HtmlAttributeName("allowInline")]
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
[HtmlAttributeName("allowKeyboardInteraction")]
public bool AllowKeyboardInteraction { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AllowMultiCellSelection
This property helps user to allow/prevent the selection of multiple cells.
{% codeBlock src='schedule/allowMultiCellSelection/index.md' %}{% endcodeBlock %}
By default, it is set to true.
Declaration
[HtmlAttributeName("allowMultiCellSelection")]
public bool AllowMultiCellSelection { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AllowMultiDrag
This property helps to drag the multiple selected events.
By default, it is set to false.
Declaration
[HtmlAttributeName("allowMultiDrag")]
public bool AllowMultiDrag { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
AllowMultiRowSelection
This property helps user to allow/prevent the selection of multiple days(rows).
{% codeBlock src='schedule/allowMultiRowSelection/index.md' %}{% endcodeBlock %}
By default, it is set to true.
Declaration
[HtmlAttributeName("allowMultiRowSelection")]
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
[HtmlAttributeName("allowResizing")]
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
[HtmlAttributeName("calendarMode")]
public CalendarType CalendarMode { get; set; }
Property Value
CellClick
Triggers when the scheduler cells are single clicked or on single tap on the same cells in mobile devices.
Declaration
[HtmlAttributeName("cellClick")]
public string CellClick { get; set; }
Property Value
| Type |
Description |
| System.String |
|
CellDoubleClick
Triggers when the scheduler cells are double clicked.
Declaration
[HtmlAttributeName("cellDoubleClick")]
public string CellDoubleClick { get; set; }
Property Value
| Type |
Description |
| System.String |
|
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
[HtmlAttributeName("cellHeaderTemplate")]
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
Declaration
[HtmlAttributeName("cellTemplate")]
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
[HtmlAttributeName("created")]
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
[HtmlAttributeName("cssClass")]
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
[HtmlAttributeName("currentView")]
public View CurrentView { get; set; }
Property Value
DataBinding
Triggers before the data binds to the scheduler.
{% codeBlock src='schedule/dataBinding/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("dataBinding")]
public string DataBinding { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DataBound
Triggers once the event data is bound to the scheduler.
{% codeBlock src='schedule/dataBound/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("dataBound")]
public string DataBound { get; set; }
Property Value
| Type |
Description |
| System.String |
|
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
[HtmlAttributeName("dateFormat")]
public string DateFormat { get; set; }
Property Value
| Type |
Description |
| System.String |
|
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
[HtmlAttributeName("dateHeaderTemplate")]
public string DateHeaderTemplate { get; set; }
Property Value
| Type |
Description |
| System.String |
|
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.
{% codeBlock src='schedule/dayHeaderTemplate/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("dayHeaderTemplate")]
public string DayHeaderTemplate { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Destroyed
Triggers when the scheduler component is destroyed.
Declaration
[HtmlAttributeName("destroyed")]
public string Destroyed { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Drag
Triggers when an appointment is being in a dragged state.
{% codeBlock src='schedule/drag/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("drag")]
public string Drag { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DragStart
Triggers when an appointment is started to drag.
{% codeBlock src='schedule/dragStart/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("dragStart")]
public string DragStart { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DragStop
Triggers when the dragging of appointment is stopped.
{% codeBlock src='schedule/dragStop/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("dragStop")]
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
[HtmlAttributeName("editorTemplate")]
public string EditorTemplate { get; set; }
Property Value
| Type |
Description |
| System.String |
|
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.
{% codeBlock src='schedule/enableAdaptiveUI/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("enableAdaptiveUI")]
public bool EnableAdaptiveUI { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
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.
{% codeBlock src='schedule/enableAllDayScroll/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("enableAllDayScroll")]
public bool EnableAllDayScroll { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
[HtmlAttributeName("enablePersistence")]
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
[HtmlAttributeName("enableRecurrenceValidation")]
public bool EnableRecurrenceValidation { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
[HtmlAttributeName("enableRtl")]
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
[HtmlAttributeName("endHour")]
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.
{% codeBlock src='schedule/eventClick/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("eventClick")]
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
[HtmlAttributeName("eventDragArea")]
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.
{% codeBlock src='schedule/eventRendered/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("eventRendered")]
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
[HtmlAttributeName("eventSettings")]
public ScheduleEventSettings EventSettings { get; set; }
Property Value
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
[HtmlAttributeName("firstDayOfWeek")]
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
[HtmlAttributeName("firstMonthOfYear")]
public double FirstMonthOfYear { 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
[HtmlAttributeName("group")]
public ScheduleGroup Group { get; set; }
Property Value
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
[HtmlAttributeName("headerRows")]
public List<ScheduleHeaderRow> HeaderRows { get; set; }
Property Value
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
[HtmlAttributeName("height")]
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
[HtmlAttributeName("hideEmptyAgendaDays")]
public bool HideEmptyAgendaDays { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Hover
Triggers when the scheduler elements are hovered.
Declaration
[HtmlAttributeName("hover")]
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
[HtmlAttributeName("htmlAttributes")]
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
[HtmlAttributeName("locale")]
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).
{% codeBlock src='schedule/maxDate/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("maxDate")]
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).
{% codeBlock src='schedule/minDate/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("minDate")]
public object MinDate { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
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.
{% codeBlock src='schedule/monthHeaderTemplate/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("monthHeaderTemplate")]
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
[HtmlAttributeName("monthsCount")]
public int MonthsCount { get; set; }
Property Value
| Type |
Description |
| System.Int32 |
|
MoreEventsClick
Triggers when the more events indicator are clicked.
Declaration
[HtmlAttributeName("moreEventsClick")]
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.
{% codeBlock src='schedule/navigating/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("navigating")]
public string Navigating { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Triggers before any of the scheduler popups close on the page.
{% codeBlock src='schedule/popupClose/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("popupClose")]
public string PopupClose { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Triggers before any of the scheduler popups opens on the page.
{% codeBlock src='schedule/popupOpen/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("popupOpen")]
public string PopupOpen { get; set; }
Property Value
| Type |
Description |
| System.String |
|
QuickInfoOnSelectionEnd
This property helps to show quick popup after multiple cell selection.
{% codeBlock src='schedule/quickInfoOnSelectionEnd/index.md' %}{% endcodeBlock %}
By default, it is set to false.
Declaration
[HtmlAttributeName("quickInfoOnSelectionEnd")]
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
[HtmlAttributeName("quickInfoTemplates")]
public ScheduleQuickInfoTemplates QuickInfoTemplates { get; set; }
Property Value
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
[HtmlAttributeName("readonly")]
public bool Readonly { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
RenderCell
Triggers before each element of the schedule rendering on the page.
{% codeBlock src='schedule/renderCell/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("renderCell")]
public string RenderCell { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ResizeStart
Triggers when an appointment is started to resize.
{% codeBlock src='schedule/resizeStart/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("resizeStart")]
public string ResizeStart { get; set; }
Property Value
| Type |
Description |
| System.String |
|
ResizeStop
Triggers when the resizing of appointment is stopped.
{% codeBlock src='schedule/resizeStop/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("resizeStop")]
public string ResizeStop { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Resizing
Triggers when an appointment is being in a resizing action.
{% codeBlock src='schedule/resizing/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("resizing")]
public string Resizing { get; set; }
Property Value
| Type |
Description |
| System.String |
|
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
[HtmlAttributeName("resourceHeaderTemplate")]
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
[HtmlAttributeName("resources")]
public List<ScheduleResource> Resources { get; set; }
Property Value
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
[HtmlAttributeName("rowAutoHeight")]
public bool RowAutoHeight { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Select
Triggers when multiple cells or events are selected on the Scheduler.
Declaration
[HtmlAttributeName("select")]
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
[HtmlAttributeName("selectedDate")]
public object SelectedDate { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
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
[HtmlAttributeName("showHeaderBar")]
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
[HtmlAttributeName("showQuickInfo")]
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
[HtmlAttributeName("showTimeIndicator")]
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
[HtmlAttributeName("showWeekend")]
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
[HtmlAttributeName("showWeekNumber")]
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
[HtmlAttributeName("startHour")]
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
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
[HtmlAttributeName("timeFormat")]
public string TimeFormat { get; set; }
Property Value
| Type |
Description |
| System.String |
|
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
[HtmlAttributeName("timeScale")]
public ScheduleTimeScale TimeScale { get; set; }
Property Value
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
[HtmlAttributeName("timezone")]
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
[HtmlAttributeName("views")]
public object Views { get; set; }
Property Value
| Type |
Description |
| System.Object |
|
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
FirstFourDayWeek
FirstFullWeek
{% codeBlock src='schedule/weekRule/index.md' %}{% endcodeBlock %}
Declaration
[HtmlAttributeName("weekRule")]
public WeekRule WeekRule { get; set; }
Property Value
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
[HtmlAttributeName("width")]
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
[HtmlAttributeName("workDays")]
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
[HtmlAttributeName("workHours")]
public ScheduleWorkHours WorkHours { get; set; }
Property Value
