SchedulerBuilder Methods
A Scheduler control.| Name | Description |
|---|---|
| AccessKey(JS) | Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option. |
| AccessKey(String) | Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option. |
| AdaptivityEnabled(JS) | Specifies whether the UI component adapts to small screens. Mirrors the client-side adaptivityEnabled option. |
| AdaptivityEnabled(Boolean) | Specifies whether the UI component adapts to small screens. Mirrors the client-side adaptivityEnabled option. |
| AllDayExpr(JS) | Specifies the name of the data source item field whose value defines whether or not the corresponding appointment is an all-day appointment. Mirrors the client-side allDayExpr option. |
| AllDayExpr(String) | Specifies the name of the data source item field whose value defines whether or not the corresponding appointment is an all-day appointment. Mirrors the client-side allDayExpr option. |
| AllDayPanelMode(AllDayPanelMode) | Specifies the display mode for the All day panel. Mirrors the client-side allDayPanelMode option. |
| AppointmentCollectorTemplate(JS) | Specifies the client-side appointmentCollectorTemplate. |
| AppointmentCollectorTemplate(RazorBlock) | Specifies the client-side appointmentCollectorTemplate. |
| AppointmentCollectorTemplate(TemplateName) | Specifies the client-side appointmentCollectorTemplate. |
| AppointmentCollectorTemplate(String) | Specifies the client-side appointmentCollectorTemplate. |
| AppointmentDragging(Action<SchedulerAppointmentDraggingBuilder>) | Configures appointment reordering using drag and drop gestures. Mirrors the client-side appointmentDragging object. |
| AppointmentTemplate(JS) | Specifies the client-side appointmentTemplate. |
| AppointmentTemplate(RazorBlock) | Specifies the client-side appointmentTemplate. |
| AppointmentTemplate(TemplateName) | Specifies the client-side appointmentTemplate. |
| AppointmentTemplate(String) | Specifies the client-side appointmentTemplate. |
| AppointmentTooltipTemplate(JS) | Specifies the client-side appointmentTooltipTemplate. |
| AppointmentTooltipTemplate(RazorBlock) | Specifies the client-side appointmentTooltipTemplate. |
| AppointmentTooltipTemplate(TemplateName) | Specifies the client-side appointmentTooltipTemplate. |
| AppointmentTooltipTemplate(String) | Specifies the client-side appointmentTooltipTemplate. |
| CellDuration(JS) | Specifies cell duration in minutes. This property's value should divide the interval between startDayHour and endDayHour into even parts. Mirrors the client-side cellDuration option. |
| CellDuration(Int32) | Specifies cell duration in minutes. This property's value should divide the interval between startDayHour and endDayHour into even parts. Mirrors the client-side cellDuration option. |
| CrossScrollingEnabled(JS) | Specifies whether or not an end user can scroll the view in both directions at the same time. Mirrors the client-side crossScrollingEnabled option. |
| CrossScrollingEnabled(Boolean) | Specifies whether or not an end user can scroll the view in both directions at the same time. Mirrors the client-side crossScrollingEnabled option. |
| CurrentDate(JS) | Specifies the current date. Mirrors the client-side currentDate option. |
| CurrentDate(DateTime) | Specifies the current date. Mirrors the client-side currentDate option. |
| CurrentDate(Double) | Specifies the current date. Mirrors the client-side currentDate option. |
| CurrentDate(String) | Specifies the current date. Mirrors the client-side currentDate option. |
| CurrentView(JS) | Specifies the displayed view. Accepts name or type of a view available in the views array. Mirrors the client-side currentView option. |
| CurrentView(SchedulerViewType) | Specifies the displayed view. Accepts name or type of a view available in the views array. Mirrors the client-side currentView option. |
| CurrentView(String) | Specifies the displayed view. Accepts name or type of a view available in the views array. Mirrors the client-side currentView option. |
| CustomizeDateNavigatorText(RazorBlock) | Customizes the date navigator's text. Mirrors the client-side customizeDateNavigatorText option. |
| CustomizeDateNavigatorText(String) | Customizes the date navigator's text. Mirrors the client-side customizeDateNavigatorText option. |
| DataCellTemplate(JS) | Specifies the client-side dataCellTemplate. |
| DataCellTemplate(RazorBlock) | Specifies the client-side dataCellTemplate. |
| DataCellTemplate(TemplateName) | Specifies the client-side dataCellTemplate. |
| DataCellTemplate(String) | Specifies the client-side dataCellTemplate. |
| DataSource(JS) | Binds the UI component to data. Mirrors the client-side dataSource option. |
| DataSource(IEnumerable, String[]) |
Binds a Scheduler control to a collection: Array, List, or IEnumerable.
|
| DataSource(Func<DataSourceFactory, OptionsOwnerBuilder>) | Binds a Scheduler control to data, allows you to configure data access from different sources: API controllers, Razor page handlers, OData services, arrays, and more. |
| DataSource(String, String[]) | Binds a Scheduler control to read-only data in JSON format. |
| DataSourceOptions(Action<DataSourceOptionsBuilder>) | Provides access to methods that mirror client-side data source options. |
| DateCellTemplate(JS) | Specifies the client-side dateCellTemplate. |
| DateCellTemplate(RazorBlock) | Specifies the client-side dateCellTemplate. |
| DateCellTemplate(TemplateName) | Specifies the client-side dateCellTemplate. |
| DateCellTemplate(String) | Specifies the client-side dateCellTemplate. |
| DateSerializationFormat(JS) | Mirrors the client-side dateSerializationFormat option. |
| DateSerializationFormat(String) | Mirrors the client-side dateSerializationFormat option. |
| DescriptionExpr(JS) | Specifies the name of the data source item field whose value holds the description of the corresponding appointment. Mirrors the client-side descriptionExpr option. |
| DescriptionExpr(String) | Specifies the name of the data source item field whose value holds the description of the corresponding appointment. Mirrors the client-side descriptionExpr option. |
| Disabled(JS) | Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option. |
| Disabled(Boolean) | Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option. |
| DropDownAppointmentTemplate(JS) | Obsolete. This API is obsolete now. |
| DropDownAppointmentTemplate(RazorBlock) | Obsolete. This API is obsolete now. |
| DropDownAppointmentTemplate(TemplateName) | Obsolete. This API is obsolete now. |
| DropDownAppointmentTemplate(String) | Obsolete. This API is obsolete now. |
| Editing(JS) | Specifies which editing operations a user can perform on appointments. Mirrors the client-side editing option. |
| Editing(Action<SchedulerEditingBuilder>) | Specifies which editing operations a user can perform on appointments. Mirrors the client-side editing object. |
| Editing(Boolean) | Specifies which editing operations a user can perform on appointments. Mirrors the client-side editing option. |
| ElementAttr(JS) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Dictionary<String, Object>) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Object) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(String, Object) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| EndDateExpr(JS) | Specifies the name of the data source item field that defines the ending of an appointment. Mirrors the client-side endDateExpr option. |
| EndDateExpr(String) | Specifies the name of the data source item field that defines the ending of an appointment. Mirrors the client-side endDateExpr option. |
| EndDateTimeZoneExpr(JS) | Specifies the name of the data source item field that defines the timezone of the appointment end date. Mirrors the client-side endDateTimeZoneExpr option. |
| EndDateTimeZoneExpr(String) | Specifies the name of the data source item field that defines the timezone of the appointment end date. Mirrors the client-side endDateTimeZoneExpr option. |
| EndDayHour(JS) | Specifies the last hour on the time scale. Accepts integer values from 0 to 24. Mirrors the client-side endDayHour option. |
| EndDayHour(Double) | Specifies the last hour on the time scale. Accepts integer values from 0 to 24. Mirrors the client-side endDayHour option. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| FirstDayOfWeek(FirstDayOfWeek) | Specifies the first day of a week. Does not apply to the agenda view. Mirrors the client-side firstDayOfWeek option. |
| FocusStateEnabled(JS) | Mirrors the client-side focusStateEnabled option. |
| FocusStateEnabled(Boolean) | Mirrors the client-side focusStateEnabled option. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| GroupByDate(JS) | If true, appointments are grouped by date first and then by resource; opposite if false. Applies only if appointments are grouped and groupOrientation is 'horizontal'. Mirrors the client-side groupByDate option. |
| GroupByDate(Boolean) | If true, appointments are grouped by date first and then by resource; opposite if false. Applies only if appointments are grouped and groupOrientation is 'horizontal'. Mirrors the client-side groupByDate option. |
| Groups(JS) | Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. Mirrors the client-side groups option. |
| Groups(IEnumerable<String>) | Specifies the resource kinds by which the scheduler's appointments are grouped in a timetable. Mirrors the client-side groups option. |
| Height(JS) | Specifies the UI component's height. Mirrors the client-side height option. |
| Height(Double) | Specifies the UI component's height. Mirrors the client-side height option. |
| Height(String) | Specifies the UI component's height. Mirrors the client-side height option. |
| Hint(JS) | Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option. |
| Hint(String) | Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option. |
| ID(JS) |
Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
|
| ID(String) |
Specifies the id attribute for the control’s HTML element.
|
| IndicatorUpdateInterval(JS) | Specifies the time interval between when the date-time indicator changes its position, in milliseconds. Mirrors the client-side indicatorUpdateInterval option. |
| IndicatorUpdateInterval(Double) | Specifies the time interval between when the date-time indicator changes its position, in milliseconds. Mirrors the client-side indicatorUpdateInterval option. |
| Max(JS) | The latest date the UI component allows you to select. Mirrors the client-side max option. |
| Max(DateTime) | The latest date the UI component allows you to select. Mirrors the client-side max option. |
| Max(Double) | The latest date the UI component allows you to select. Mirrors the client-side max option. |
| Max(String) | The latest date the UI component allows you to select. Mirrors the client-side max option. |
| MaxAppointmentsPerCell(JS) | Specifies the limit of full-sized appointments displayed per cell. Applies to all views except 'agenda'. Mirrors the client-side maxAppointmentsPerCell option. |
| MaxAppointmentsPerCell(MaxAppointmentsPerCell) | Specifies the limit of full-sized appointments displayed per cell. Applies to all views except 'agenda'. Mirrors the client-side maxAppointmentsPerCell option. |
| MaxAppointmentsPerCell(Int32) | Specifies the limit of full-sized appointments displayed per cell. Applies to all views except 'agenda'. Mirrors the client-side maxAppointmentsPerCell option. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| Min(JS) | The earliest date the UI component allows you to select. Mirrors the client-side min option. |
| Min(DateTime) | The earliest date the UI component allows you to select. Mirrors the client-side min option. |
| Min(Double) | The earliest date the UI component allows you to select. Mirrors the client-side min option. |
| Min(String) | The earliest date the UI component allows you to select. Mirrors the client-side min option. |
| NoDataText(JS) | Specifies the text or HTML markup displayed by the UI component if the item collection is empty. Available for the Agenda view only. Mirrors the client-side noDataText option. |
| NoDataText(String) | Specifies the text or HTML markup displayed by the UI component if the item collection is empty. Available for the Agenda view only. Mirrors the client-side noDataText option. |
| Offset(JS) | |
| Offset(Double) | |
| OnAppointmentAdded(RazorBlock) | A function that is executed after an appointment is added to the data source. Mirrors the client-side onAppointmentAdded option. |
| OnAppointmentAdded(String) | A function that is executed after an appointment is added to the data source. Mirrors the client-side onAppointmentAdded option. |
| OnAppointmentAdding(RazorBlock) | A function that is executed before an appointment is added to the data source. Mirrors the client-side onAppointmentAdding option. |
| OnAppointmentAdding(String) | A function that is executed before an appointment is added to the data source. Mirrors the client-side onAppointmentAdding option. |
| OnAppointmentClick(RazorBlock) | A function that is executed when an appointment is clicked or tapped. Mirrors the client-side onAppointmentClick option. |
| OnAppointmentClick(String) | A function that is executed when an appointment is clicked or tapped. Mirrors the client-side onAppointmentClick option. |
| OnAppointmentContextMenu(RazorBlock) | A function that is executed when a user attempts to open the browser's context menu for an appointment. Allows you to replace this context menu with a custom context menu. Mirrors the client-side onAppointmentContextMenu option. |
| OnAppointmentContextMenu(String) | A function that is executed when a user attempts to open the browser's context menu for an appointment. Allows you to replace this context menu with a custom context menu. Mirrors the client-side onAppointmentContextMenu option. |
| OnAppointmentDblClick(RazorBlock) | A function that is executed when an appointment is double-clicked or double-tapped. Mirrors the client-side onAppointmentDblClick option. |
| OnAppointmentDblClick(String) | A function that is executed when an appointment is double-clicked or double-tapped. Mirrors the client-side onAppointmentDblClick option. |
| OnAppointmentDeleted(RazorBlock) | A function that is executed after an appointment is deleted from the data source. Mirrors the client-side onAppointmentDeleted option. |
| OnAppointmentDeleted(String) | A function that is executed after an appointment is deleted from the data source. Mirrors the client-side onAppointmentDeleted option. |
| OnAppointmentDeleting(RazorBlock) | A function that is executed before an appointment is deleted from the data source. Mirrors the client-side onAppointmentDeleting option. |
| OnAppointmentDeleting(String) | A function that is executed before an appointment is deleted from the data source. Mirrors the client-side onAppointmentDeleting option. |
| OnAppointmentFormOpening(RazorBlock) | A function that is executed before an appointment details form appears. Use this function to customize the form. Mirrors the client-side onAppointmentFormOpening option. |
| OnAppointmentFormOpening(String) | A function that is executed before an appointment details form appears. Use this function to customize the form. Mirrors the client-side onAppointmentFormOpening option. |
| OnAppointmentRendered(RazorBlock) | A function that is executed when an appointment is rendered. Mirrors the client-side onAppointmentRendered option. |
| OnAppointmentRendered(String) | A function that is executed when an appointment is rendered. Mirrors the client-side onAppointmentRendered option. |
| OnAppointmentTooltipShowing(RazorBlock) | Occurs before showing an appointment's tooltip. Mirrors the client-side onAppointmentTooltipShowing option. |
| OnAppointmentTooltipShowing(String) | Occurs before showing an appointment's tooltip. Mirrors the client-side onAppointmentTooltipShowing option. |
| OnAppointmentUpdated(RazorBlock) | A function that is executed after an appointment is updated in the data source. Mirrors the client-side onAppointmentUpdated option. |
| OnAppointmentUpdated(String) | A function that is executed after an appointment is updated in the data source. Mirrors the client-side onAppointmentUpdated option. |
| OnAppointmentUpdating(RazorBlock) | A function that is executed before an appointment is updated in the data source. Mirrors the client-side onAppointmentUpdating option. |
| OnAppointmentUpdating(String) | A function that is executed before an appointment is updated in the data source. Mirrors the client-side onAppointmentUpdating option. |
| OnCellClick(RazorBlock) | A function that is executed when a view cell is clicked. Mirrors the client-side onCellClick option. |
| OnCellClick(String) | A function that is executed when a view cell is clicked. Mirrors the client-side onCellClick option. |
| OnCellContextMenu(RazorBlock) | A function that is executed when a user attempts to open the browser's context menu for a cell. Allows you to replace this context menu with a custom context menu. Mirrors the client-side onCellContextMenu option. |
| OnCellContextMenu(String) | A function that is executed when a user attempts to open the browser's context menu for a cell. Allows you to replace this context menu with a custom context menu. Mirrors the client-side onCellContextMenu option. |
| OnContentReady(RazorBlock) | A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option. |
| OnContentReady(String) | A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option. |
| OnDisposing(RazorBlock) | A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option. |
| OnDisposing(String) | A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option. |
| OnInitialized(RazorBlock) | A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option. |
| OnInitialized(String) | A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option. |
| OnOptionChanged(RazorBlock) | A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option. |
| OnOptionChanged(String) | A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option. |
| Option(String, Object) | Specifies an option by its name. |
| RecurrenceEditMode(SchedulerRecurrenceEditMode) | Specifies the edit mode for recurring appointments. Mirrors the client-side recurrenceEditMode option. |
| RecurrenceExceptionExpr(JS) | Specifies the name of the data source item field that defines exceptions for the current recurring appointment. Mirrors the client-side recurrenceExceptionExpr option. |
| RecurrenceExceptionExpr(String) | Specifies the name of the data source item field that defines exceptions for the current recurring appointment. Mirrors the client-side recurrenceExceptionExpr option. |
| RecurrenceRuleExpr(JS) | Specifies the name of the data source item field that defines a recurrence rule for generating recurring appointments. Mirrors the client-side recurrenceRuleExpr option. |
| RecurrenceRuleExpr(String) | Specifies the name of the data source item field that defines a recurrence rule for generating recurring appointments. Mirrors the client-side recurrenceRuleExpr option. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| RemoteFiltering(JS) | Specifies whether filtering is performed on the server or client side. Mirrors the client-side remoteFiltering option. |
| RemoteFiltering(Boolean) | Specifies whether filtering is performed on the server or client side. Mirrors the client-side remoteFiltering option. |
| Render() | Inherited from WidgetBuilder. |
| ResourceCellTemplate(JS) | Specifies the client-side resourceCellTemplate. |
| ResourceCellTemplate(RazorBlock) | Specifies the client-side resourceCellTemplate. |
| ResourceCellTemplate(TemplateName) | Specifies the client-side resourceCellTemplate. |
| ResourceCellTemplate(String) | Specifies the client-side resourceCellTemplate. |
| Resources(Action<CollectionFactory<SchedulerResourceBuilder>>) | Provides access to the client-side resources option that represents a Scheduler resource collection. |
| RtlEnabled(JS) | Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option. |
| RtlEnabled(Boolean) | Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option. |
| Scrolling(Action<SchedulerScrollingBuilder>) | Configures scrolling. Mirrors the client-side scrolling object. |
| ShadeUntilCurrentTime(JS) | Specifies whether to apply shading to cover the timetable up to the current time. Mirrors the client-side shadeUntilCurrentTime option. |
| ShadeUntilCurrentTime(Boolean) | Specifies whether to apply shading to cover the timetable up to the current time. Mirrors the client-side shadeUntilCurrentTime option. |
| ShowAllDayPanel(JS) | Specifies the 'All-day' panel's visibility. Setting this property to false hides the panel along with the all-day appointments. Mirrors the client-side showAllDayPanel option. |
| ShowAllDayPanel(Boolean) | Specifies the 'All-day' panel's visibility. Setting this property to false hides the panel along with the all-day appointments. Mirrors the client-side showAllDayPanel option. |
| ShowCurrentTimeIndicator(JS) | Specifies the current date-time indicator's visibility. Mirrors the client-side showCurrentTimeIndicator option. |
| ShowCurrentTimeIndicator(Boolean) | Specifies the current date-time indicator's visibility. Mirrors the client-side showCurrentTimeIndicator option. |
| StartDateExpr(JS) | Specifies the name of the data source item field that defines the start of an appointment. Mirrors the client-side startDateExpr option. |
| StartDateExpr(String) | Specifies the name of the data source item field that defines the start of an appointment. Mirrors the client-side startDateExpr option. |
| StartDateTimeZoneExpr(JS) | Specifies the name of the data source item field that defines the timezone of the appointment start date. Mirrors the client-side startDateTimeZoneExpr option. |
| StartDateTimeZoneExpr(String) | Specifies the name of the data source item field that defines the timezone of the appointment start date. Mirrors the client-side startDateTimeZoneExpr option. |
| StartDayHour(JS) | Specifies the first hour on the time scale. Accepts integer values from 0 to 24. Mirrors the client-side startDayHour option. |
| StartDayHour(Double) | Specifies the first hour on the time scale. Accepts integer values from 0 to 24. Mirrors the client-side startDayHour option. |
| TabIndex(JS) | Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option. |
| TabIndex(Int32) | Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option. |
| TextExpr(JS) | Specifies the name of the data source item field that holds the subject of an appointment. Mirrors the client-side textExpr option. |
| TextExpr(String) | Specifies the name of the data source item field that holds the subject of an appointment. Mirrors the client-side textExpr option. |
| TimeCellTemplate(JS) | Specifies the client-side timeCellTemplate. |
| TimeCellTemplate(RazorBlock) | Specifies the client-side timeCellTemplate. |
| TimeCellTemplate(TemplateName) | Specifies the client-side timeCellTemplate. |
| TimeCellTemplate(String) | Specifies the client-side timeCellTemplate. |
| TimeZone(JS) | Specifies the time zone for the Scheduler's grid. Accepts values from the IANA time zone database. Mirrors the client-side timeZone option. |
| TimeZone(String) | Specifies the time zone for the Scheduler's grid. Accepts values from the IANA time zone database. Mirrors the client-side timeZone option. |
| ToString() | Inherited from WidgetBuilder. |
| ToTemplate() | Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder. |
| UseDropDownViewSwitcher(JS) | Specifies whether a user can switch views using tabs or a drop-down menu. Mirrors the client-side useDropDownViewSwitcher option. |
| UseDropDownViewSwitcher(Boolean) | Specifies whether a user can switch views using tabs or a drop-down menu. Mirrors the client-side useDropDownViewSwitcher option. |
| Views(Action<CollectionFactory<SchedulerViewBuilder>>) | Provides access to the client-side views option that represents a Scheduler view collection. |
| Views(IEnumerable<SchedulerViewType>) | Specifies and configures the views to be available in the view switcher. Mirrors the client-side views option. |
| Visible(JS) | Specifies whether the UI component is visible. Mirrors the client-side visible option. |
| Visible(Boolean) | Specifies whether the UI component is visible. Mirrors the client-side visible option. |
| Width(JS) | Specifies the UI component's width. Mirrors the client-side width option. |
| Width(Double) | Specifies the UI component's width. Mirrors the client-side width option. |
| Width(String) | Specifies the UI component's width. Mirrors the client-side width option. |
See Also