ASP.NET Core - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ScheduleBuilder - ASP.NETCore-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ScheduleBuilder

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

    Constructors

    ScheduleBuilder()

    Declaration
    public ScheduleBuilder()

    ScheduleBuilder(Schedule)

    Declaration
    public ScheduleBuilder(Schedule model)
    Parameters
    Type Name Description
    Schedule model

    Fields

    model

    Declaration
    public Schedule model
    Field Value
    Type Description
    Schedule

    Properties

    HtmlAttr

    Declaration
    public IDictionary<string, object> HtmlAttr { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    ID

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

    Output

    Declaration
    public override TextWriter Output { get; set; }
    Property Value
    Type Description
    System.IO.TextWriter
    Overrides
    ControlBuilder.Output

    Methods

    ActionBegin(String)

    Triggers on beginning of every scheduler action.

    Declaration
    public ScheduleBuilder ActionBegin(string actionBegin)
    Parameters
    Type Name Description
    System.String actionBegin
    Returns
    Type Description
    ScheduleBuilder

    ActionComplete(String)

    Triggers on successful completion of the scheduler actions.

    Declaration
    public ScheduleBuilder ActionComplete(string actionComplete)
    Parameters
    Type Name Description
    System.String actionComplete
    Returns
    Type Description
    ScheduleBuilder

    ActionFailure(String)

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

    Declaration
    public ScheduleBuilder ActionFailure(string actionFailure)
    Parameters
    Type Name Description
    System.String actionFailure
    Returns
    Type Description
    ScheduleBuilder

    AgendaDaysCount(Double)

    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 ScheduleBuilder AgendaDaysCount(double agendaDaysCount)
    Parameters
    Type Name Description
    System.Double agendaDaysCount
    Returns
    Type Description
    ScheduleBuilder

    AllowDragAndDrop(Boolean)

    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 ScheduleBuilder AllowDragAndDrop(bool allowDragAndDrop = true)
    Parameters
    Type Name Description
    System.Boolean allowDragAndDrop
    Returns
    Type Description
    ScheduleBuilder

    AllowInline(Boolean)

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

    Declaration
    public ScheduleBuilder AllowInline(bool allowInline = true)
    Parameters
    Type Name Description
    System.Boolean allowInline
    Returns
    Type Description
    ScheduleBuilder

    AllowKeyboardInteraction(Boolean)

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

    Declaration
    public ScheduleBuilder AllowKeyboardInteraction(bool allowKeyboardInteraction = true)
    Parameters
    Type Name Description
    System.Boolean allowKeyboardInteraction
    Returns
    Type Description
    ScheduleBuilder

    AllowMultiCellSelection(Boolean)

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

    Declaration
    public ScheduleBuilder AllowMultiCellSelection(bool allowMultiCellSelection = true)
    Parameters
    Type Name Description
    System.Boolean allowMultiCellSelection
    Returns
    Type Description
    ScheduleBuilder

    AllowMultiRowSelection(Boolean)

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

    Declaration
    public ScheduleBuilder AllowMultiRowSelection(bool allowMultiRowSelection = true)
    Parameters
    Type Name Description
    System.Boolean allowMultiRowSelection
    Returns
    Type Description
    ScheduleBuilder

    AllowResizing(Boolean)

    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 ScheduleBuilder AllowResizing(bool allowResizing = true)
    Parameters
    Type Name Description
    System.Boolean allowResizing
    Returns
    Type Description
    ScheduleBuilder

    CalendarMode(CalendarType)

    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 ScheduleBuilder CalendarMode(CalendarType calendarMode)
    Parameters
    Type Name Description
    CalendarType calendarMode
    Returns
    Type Description
    ScheduleBuilder

    CellClick(String)

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

    Declaration
    public ScheduleBuilder CellClick(string cellClick)
    Parameters
    Type Name Description
    System.String cellClick
    Returns
    Type Description
    ScheduleBuilder

    CellDoubleClick(String)

    Triggers when the scheduler cells are double clicked.

    Declaration
    public ScheduleBuilder CellDoubleClick(string cellDoubleClick)
    Parameters
    Type Name Description
    System.String cellDoubleClick
    Returns
    Type Description
    ScheduleBuilder

    CellHeaderTemplate(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
    public ScheduleBuilder CellHeaderTemplate(string cellHeaderTemplate)
    Parameters
    Type Name Description
    System.String cellHeaderTemplate
    Returns
    Type Description
    ScheduleBuilder

    CellTemplate(String)

    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 ScheduleBuilder CellTemplate(string cellTemplate)
    Parameters
    Type Name Description
    System.String cellTemplate
    Returns
    Type Description
    ScheduleBuilder

    Created(String)

    Triggers after the scheduler component is created.

    Declaration
    public ScheduleBuilder Created(string created)
    Parameters
    Type Name Description
    System.String created
    Returns
    Type Description
    ScheduleBuilder

    CssClass(String)

    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 ScheduleBuilder CssClass(string cssClass)
    Parameters
    Type Name Description
    System.String cssClass
    Returns
    Type Description
    ScheduleBuilder

    CurrentView(View)

    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 ScheduleBuilder CurrentView(View currentView)
    Parameters
    Type Name Description
    View currentView
    Returns
    Type Description
    ScheduleBuilder

    DataBinding(String)

    Triggers before the data binds to the scheduler.

    Declaration
    public ScheduleBuilder DataBinding(string dataBinding)
    Parameters
    Type Name Description
    System.String dataBinding
    Returns
    Type Description
    ScheduleBuilder

    DataBound(String)

    Triggers once the event data is bound to the scheduler.

    Declaration
    public ScheduleBuilder DataBound(string dataBound)
    Parameters
    Type Name Description
    System.String dataBound
    Returns
    Type Description
    ScheduleBuilder

    DateFormat(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
    public ScheduleBuilder DateFormat(string dateFormat)
    Parameters
    Type Name Description
    System.String dateFormat
    Returns
    Type Description
    ScheduleBuilder

    DateHeaderTemplate(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
    public ScheduleBuilder DateHeaderTemplate(string dateHeaderTemplate)
    Parameters
    Type Name Description
    System.String dateHeaderTemplate
    Returns
    Type Description
    ScheduleBuilder

    Destroyed(String)

    Triggers when the scheduler component is destroyed.

    Declaration
    public ScheduleBuilder Destroyed(string destroyed)
    Parameters
    Type Name Description
    System.String destroyed
    Returns
    Type Description
    ScheduleBuilder

    Drag(String)

    Triggers when an appointment is being in a dragged state.

    Declaration
    public ScheduleBuilder Drag(string drag)
    Parameters
    Type Name Description
    System.String drag
    Returns
    Type Description
    ScheduleBuilder

    DragStart(String)

    Triggers when an appointment is started to drag.

    Declaration
    public ScheduleBuilder DragStart(string dragStart)
    Parameters
    Type Name Description
    System.String dragStart
    Returns
    Type Description
    ScheduleBuilder

    DragStop(String)

    Triggers when the dragging of appointment is stopped.

    Declaration
    public ScheduleBuilder DragStop(string dragStop)
    Parameters
    Type Name Description
    System.String dragStop
    Returns
    Type Description
    ScheduleBuilder

    EditorTemplate(String)

    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 ScheduleBuilder EditorTemplate(string editorTemplate)
    Parameters
    Type Name Description
    System.String editorTemplate
    Returns
    Type Description
    ScheduleBuilder

    EnablePersistence(Boolean)

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

    Declaration
    public ScheduleBuilder EnablePersistence(bool enablePersistence = true)
    Parameters
    Type Name Description
    System.Boolean enablePersistence
    Returns
    Type Description
    ScheduleBuilder

    EnableRecurrenceValidation(Boolean)

    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 ScheduleBuilder EnableRecurrenceValidation(bool enableRecurrenceValidation = true)
    Parameters
    Type Name Description
    System.Boolean enableRecurrenceValidation
    Returns
    Type Description
    ScheduleBuilder

    EnableRtl(Boolean)

    Enable or disable rendering component in right to left direction.

    Declaration
    public ScheduleBuilder EnableRtl(bool enableRtl = true)
    Parameters
    Type Name Description
    System.Boolean enableRtl
    Returns
    Type Description
    ScheduleBuilder

    EndHour(String)

    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 ScheduleBuilder EndHour(string endHour)
    Parameters
    Type Name Description
    System.String endHour
    Returns
    Type Description
    ScheduleBuilder

    EventClick(String)

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

    Declaration
    public ScheduleBuilder EventClick(string eventClick)
    Parameters
    Type Name Description
    System.String eventClick
    Returns
    Type Description
    ScheduleBuilder

    EventDragArea(String)

    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 ScheduleBuilder EventDragArea(string eventDragArea)
    Parameters
    Type Name Description
    System.String eventDragArea
    Returns
    Type Description
    ScheduleBuilder

    EventRendered(String)

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

    Declaration
    public ScheduleBuilder EventRendered(string eventRendered)
    Parameters
    Type Name Description
    System.String eventRendered
    Returns
    Type Description
    ScheduleBuilder

    EventSettings(ScheduleEventSettings)

    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 ScheduleBuilder EventSettings(ScheduleEventSettings eventSettings)
    Parameters
    Type Name Description
    ScheduleEventSettings eventSettings
    Returns
    Type Description
    ScheduleBuilder

    EventSettings(Action<ScheduleEventSettingsBuilder>)

    Declaration
    public ScheduleBuilder EventSettings(Action<ScheduleEventSettingsBuilder> eventSettings)
    Parameters
    Type Name Description
    System.Action<ScheduleEventSettingsBuilder> eventSettings
    Returns
    Type Description
    ScheduleBuilder

    FirstDayOfWeek(Double)

    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 ScheduleBuilder FirstDayOfWeek(double firstDayOfWeek)
    Parameters
    Type Name Description
    System.Double firstDayOfWeek
    Returns
    Type Description
    ScheduleBuilder

    Group(ScheduleGroup)

    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 ScheduleBuilder Group(ScheduleGroup group)
    Parameters
    Type Name Description
    ScheduleGroup group
    Returns
    Type Description
    ScheduleBuilder

    Group(Action<ScheduleGroupBuilder>)

    Declaration
    public ScheduleBuilder Group(Action<ScheduleGroupBuilder> group)
    Parameters
    Type Name Description
    System.Action<ScheduleGroupBuilder> group
    Returns
    Type Description
    ScheduleBuilder

    HeaderRows(Action<ScheduleHeaderRowBuilder>)

    Declaration
    public ScheduleBuilder HeaderRows(Action<ScheduleHeaderRowBuilder> headerRows)
    Parameters
    Type Name Description
    System.Action<ScheduleHeaderRowBuilder> headerRows
    Returns
    Type Description
    ScheduleBuilder

    HeaderRows(List<ScheduleHeaderRow>)

    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 ScheduleBuilder HeaderRows(List<ScheduleHeaderRow> headerRows)
    Parameters
    Type Name Description
    System.Collections.Generic.List<ScheduleHeaderRow> headerRows
    Returns
    Type Description
    ScheduleBuilder

    Height(Double)

    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 ScheduleBuilder Height(double height)
    Parameters
    Type Name Description
    System.Double height
    Returns
    Type Description
    ScheduleBuilder

    Height(String)

    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 ScheduleBuilder Height(string height)
    Parameters
    Type Name Description
    System.String height
    Returns
    Type Description
    ScheduleBuilder

    HideEmptyAgendaDays(Boolean)

    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 ScheduleBuilder HideEmptyAgendaDays(bool hideEmptyAgendaDays = true)
    Parameters
    Type Name Description
    System.Boolean hideEmptyAgendaDays
    Returns
    Type Description
    ScheduleBuilder

    Hover(String)

    Triggers when the scheduler elements are hovered.

    Declaration
    public ScheduleBuilder Hover(string hover)
    Parameters
    Type Name Description
    System.String hover
    Returns
    Type Description
    ScheduleBuilder

    HtmlAttributes(Object)

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

    Declaration
    public ScheduleBuilder HtmlAttributes(object htmlAttributes)
    Parameters
    Type Name Description
    System.Object htmlAttributes
    Returns
    Type Description
    ScheduleBuilder

    Locale(String)

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

    Declaration
    public ScheduleBuilder Locale(string locale)
    Parameters
    Type Name Description
    System.String locale
    Returns
    Type Description
    ScheduleBuilder

    MaxDate(Object)

    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 ScheduleBuilder MaxDate(object maxDate)
    Parameters
    Type Name Description
    System.Object maxDate
    Returns
    Type Description
    ScheduleBuilder

    MinDate(Object)

    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 ScheduleBuilder MinDate(object minDate)
    Parameters
    Type Name Description
    System.Object minDate
    Returns
    Type Description
    ScheduleBuilder

    MoreEventsClick(String)

    Triggers when the more events indicator are clicked.

    Declaration
    public ScheduleBuilder MoreEventsClick(string moreEventsClick)
    Parameters
    Type Name Description
    System.String moreEventsClick
    Returns
    Type Description
    ScheduleBuilder

    Navigating(String)

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

    Declaration
    public ScheduleBuilder Navigating(string navigating)
    Parameters
    Type Name Description
    System.String navigating
    Returns
    Type Description
    ScheduleBuilder

    PopupClose(String)

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

    Declaration
    public ScheduleBuilder PopupClose(string popupClose)
    Parameters
    Type Name Description
    System.String popupClose
    Returns
    Type Description
    ScheduleBuilder

    PopupOpen(String)

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

    Declaration
    public ScheduleBuilder PopupOpen(string popupOpen)
    Parameters
    Type Name Description
    System.String popupOpen
    Returns
    Type Description
    ScheduleBuilder

    QuickInfoOnSelectionEnd(Boolean)

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

    Declaration
    public ScheduleBuilder QuickInfoOnSelectionEnd(bool quickInfoOnSelectionEnd = true)
    Parameters
    Type Name Description
    System.Boolean quickInfoOnSelectionEnd
    Returns
    Type Description
    ScheduleBuilder

    QuickInfoTemplates(ScheduleQuickInfoTemplates)

    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 ScheduleBuilder QuickInfoTemplates(ScheduleQuickInfoTemplates quickInfoTemplates)
    Parameters
    Type Name Description
    ScheduleQuickInfoTemplates quickInfoTemplates
    Returns
    Type Description
    ScheduleBuilder

    QuickInfoTemplates(Action<ScheduleQuickInfoTemplatesBuilder>)

    Declaration
    public ScheduleBuilder QuickInfoTemplates(Action<ScheduleQuickInfoTemplatesBuilder> quickInfoTemplates)
    Parameters
    Type Name Description
    System.Action<ScheduleQuickInfoTemplatesBuilder> quickInfoTemplates
    Returns
    Type Description
    ScheduleBuilder

    Readonly(Boolean)

    Declaration
    public ScheduleBuilder Readonly(bool readOnly = true)
    Parameters
    Type Name Description
    System.Boolean readOnly
    Returns
    Type Description
    ScheduleBuilder

    Render()

    Declaration
    public HtmlString Render()
    Returns
    Type Description
    Microsoft.AspNetCore.Html.HtmlString

    RenderCell(String)

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

    Declaration
    public ScheduleBuilder RenderCell(string renderCell)
    Parameters
    Type Name Description
    System.String renderCell
    Returns
    Type Description
    ScheduleBuilder

    ResizeStart(String)

    Triggers when an appointment is started to resize.

    Declaration
    public ScheduleBuilder ResizeStart(string resizeStart)
    Parameters
    Type Name Description
    System.String resizeStart
    Returns
    Type Description
    ScheduleBuilder

    ResizeStop(String)

    Triggers when the resizing of appointment is stopped.

    Declaration
    public ScheduleBuilder ResizeStop(string resizeStop)
    Parameters
    Type Name Description
    System.String resizeStop
    Returns
    Type Description
    ScheduleBuilder

    Resizing(String)

    Triggers when an appointment is being in a resizing action.

    Declaration
    public ScheduleBuilder Resizing(string resizing)
    Parameters
    Type Name Description
    System.String resizing
    Returns
    Type Description
    ScheduleBuilder

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

    Declaration
    public ScheduleBuilder ResourceHeaderTemplate(string resourceHeaderTemplate)
    Parameters
    Type Name Description
    System.String resourceHeaderTemplate
    Returns
    Type Description
    ScheduleBuilder

    Resources(Action<ScheduleResourceBuilder>)

    Declaration
    public ScheduleBuilder Resources(Action<ScheduleResourceBuilder> resources)
    Parameters
    Type Name Description
    System.Action<ScheduleResourceBuilder> resources
    Returns
    Type Description
    ScheduleBuilder

    Resources(List<ScheduleResource>)

    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 ScheduleBuilder Resources(List<ScheduleResource> resources)
    Parameters
    Type Name Description
    System.Collections.Generic.List<ScheduleResource> resources
    Returns
    Type Description
    ScheduleBuilder

    RowAutoHeight(Boolean)

    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 ScheduleBuilder RowAutoHeight(bool rowAutoHeight = true)
    Parameters
    Type Name Description
    System.Boolean rowAutoHeight
    Returns
    Type Description
    ScheduleBuilder

    Select(String)

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

    Declaration
    public ScheduleBuilder Select(string select)
    Parameters
    Type Name Description
    System.String select
    Returns
    Type Description
    ScheduleBuilder

    SelectedDate(Object)

    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 ScheduleBuilder SelectedDate(object selectedDate)
    Parameters
    Type Name Description
    System.Object selectedDate
    Returns
    Type Description
    ScheduleBuilder

    ShowHeaderBar(Boolean)

    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 ScheduleBuilder ShowHeaderBar(bool showHeaderBar = true)
    Parameters
    Type Name Description
    System.Boolean showHeaderBar
    Returns
    Type Description
    ScheduleBuilder

    ShowQuickInfo(Boolean)

    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 ScheduleBuilder ShowQuickInfo(bool showQuickInfo = true)
    Parameters
    Type Name Description
    System.Boolean showQuickInfo
    Returns
    Type Description
    ScheduleBuilder

    ShowTimeIndicator(Boolean)

    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 ScheduleBuilder ShowTimeIndicator(bool showTimeIndicator = true)
    Parameters
    Type Name Description
    System.Boolean showTimeIndicator
    Returns
    Type Description
    ScheduleBuilder

    ShowWeekend(Boolean)

    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 ScheduleBuilder ShowWeekend(bool showWeekend = true)
    Parameters
    Type Name Description
    System.Boolean showWeekend
    Returns
    Type Description
    ScheduleBuilder

    ShowWeekNumber(Boolean)

    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 ScheduleBuilder ShowWeekNumber(bool showWeekNumber = true)
    Parameters
    Type Name Description
    System.Boolean showWeekNumber
    Returns
    Type Description
    ScheduleBuilder

    StartHour(String)

    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 ScheduleBuilder StartHour(string startHour)
    Parameters
    Type Name Description
    System.String startHour
    Returns
    Type Description
    ScheduleBuilder

    TimeScale(ScheduleTimeScale)

    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 ScheduleBuilder TimeScale(ScheduleTimeScale timeScale)
    Parameters
    Type Name Description
    ScheduleTimeScale timeScale
    Returns
    Type Description
    ScheduleBuilder

    TimeScale(Action<ScheduleTimeScaleBuilder>)

    Declaration
    public ScheduleBuilder TimeScale(Action<ScheduleTimeScaleBuilder> timeScale)
    Parameters
    Type Name Description
    System.Action<ScheduleTimeScaleBuilder> timeScale
    Returns
    Type Description
    ScheduleBuilder

    Timezone(String)

    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 ScheduleBuilder Timezone(string timezone)
    Parameters
    Type Name Description
    System.String timezone
    Returns
    Type Description
    ScheduleBuilder

    Views(Action<ScheduleViewBuilder>)

    Declaration
    public ScheduleBuilder Views(Action<ScheduleViewBuilder> views)
    Parameters
    Type Name Description
    System.Action<ScheduleViewBuilder> views
    Returns
    Type Description
    ScheduleBuilder

    Views(List<ScheduleView>)

    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 ScheduleBuilder Views(List<ScheduleView> views)
    Parameters
    Type Name Description
    System.Collections.Generic.List<ScheduleView> views
    Returns
    Type Description
    ScheduleBuilder

    Views(Object)

    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 ScheduleBuilder Views(object views)
    Parameters
    Type Name Description
    System.Object views
    Returns
    Type Description
    ScheduleBuilder

    Width(Double)

    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 ScheduleBuilder Width(double width)
    Parameters
    Type Name Description
    System.Double width
    Returns
    Type Description
    ScheduleBuilder

    Width(String)

    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 ScheduleBuilder Width(string width)
    Parameters
    Type Name Description
    System.String width
    Returns
    Type Description
    ScheduleBuilder

    WorkDays(Int32[])

    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 ScheduleBuilder WorkDays(int[] workDays)
    Parameters
    Type Name Description
    System.Int32[] workDays
    Returns
    Type Description
    ScheduleBuilder

    WorkHours(ScheduleWorkHours)

    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 ScheduleBuilder WorkHours(ScheduleWorkHours workHours)
    Parameters
    Type Name Description
    ScheduleWorkHours workHours
    Returns
    Type Description
    ScheduleBuilder

    WorkHours(Action<ScheduleWorkHoursBuilder>)

    Declaration
    public ScheduleBuilder WorkHours(Action<ScheduleWorkHoursBuilder> workHours)
    Parameters
    Type Name Description
    System.Action<ScheduleWorkHoursBuilder> workHours
    Returns
    Type Description
    ScheduleBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved