Class SchedulePropertiesBuilder
A builder class that holds all Schedule properties.
Inheritance
Inherited Members
Namespace: Syncfusion.JavaScript
Assembly: Syncfusion.EJ.dll
Syntax
public class SchedulePropertiesBuilder : IPropertiesBuilder, IHtmlStringConstructors
SchedulePropertiesBuilder()
Initializes a new instance of the SchedulePropertiesBuilder class.
Declaration
public SchedulePropertiesBuilder()SchedulePropertiesBuilder(Schedule)
Initializes a new instance of the SchedulePropertiesBuilder class.
Declaration
public SchedulePropertiesBuilder(Schedule schedule)Parameters
| Type | Name | Description |
|---|---|---|
| Schedule | schedule | It accepts the Schedule object. |
Fields
schedule
It stores the value for schedule object.
Declaration
public Schedule scheduleField Value
| Type | Description |
|---|---|
| Schedule |
Methods
AgendaViewSettings(Action<AgendaViewSettingsBuilder>)
It stores all the options related to agenda view settings of the Schedule.
Declaration
public SchedulePropertiesBuilder AgendaViewSettings(Action<AgendaViewSettingsBuilder> agendaViewSettings)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<AgendaViewSettingsBuilder> | agendaViewSettings | It accept all the options related to agenda view settings of the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
AllDayCellsTemplateId(String)
This field stores the AllDayCells template value.
Declaration
public SchedulePropertiesBuilder AllDayCellsTemplateId(string allDayCellsTemplateId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | allDayCellsTemplateId | It accepts the AllDayCells template value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
AllowDelete()
This field stores the value which indicates whether to disable the appointment delete option on the Scheduler or not.
Declaration
public SchedulePropertiesBuilder AllowDelete()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
AllowDragAndDrop()
This field stores the value which indicates whether to allow the appointments to be dragged and dropped at required time.
Declaration
public SchedulePropertiesBuilder AllowDragAndDrop()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
AllowDragAndDrop(Boolean)
This field stores the value which indicates whether to allow the appointments to be dragged and dropped at required time.
Declaration
public SchedulePropertiesBuilder AllowDragAndDrop(bool allowDragAndDrop)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | allowDragAndDrop | It accepts the value which indicates whether to allow the appointments to be dragged and dropped at required time. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
AllowDragDrop()
This field stores the value which indicates whether to allow the appointments to be dragged and dropped at required time.
Declaration
public SchedulePropertiesBuilder AllowDragDrop()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
AllowDragDrop(Boolean)
This field stores the value which indicates whether to allow the appointments to be dragged and dropped at required time.
Declaration
public SchedulePropertiesBuilder AllowDragDrop(bool allowDragDrop)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | allowDragDrop | It accepts the value which indicates whether to allow the appointments to be dragged and dropped at required time. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
AllowInline()
This field stores the value which indicates whether to allow the user to create/edit appointments through a single cell click or not.
Declaration
public SchedulePropertiesBuilder AllowInline()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
AllowInline(Boolean)
This field stores the value which indicates whether to allow the user to create/edit appointments through a single cell click or not.
Declaration
public SchedulePropertiesBuilder AllowInline(bool allowInline)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | allowInline | It accepts the value which indicates whether to allow the user to create/edit appointments through a single cell click or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
AllowKeyboardNavigation()
This field stores the value which indicates whether to allows interaction through keyboard shortcut keys or not.
Declaration
public SchedulePropertiesBuilder AllowKeyboardNavigation()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
AllowKeyboardNavigation(Boolean)
This field stores the value which indicates whether to allows interaction through keyboard shortcut keys or not.
Declaration
public SchedulePropertiesBuilder AllowKeyboardNavigation(bool allowKeyboardNavigation)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | allowKeyboardNavigation | It accept the value which indicates whether to allows interaction through keyboard shortcut keys or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
AppointmentDragArea(String)
This field stores the draggable area value for the Scheduler appointments.
Declaration
public SchedulePropertiesBuilder AppointmentDragArea(string appointmentDragArea)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | appointmentDragArea | It accepts the draggable area value for the Scheduler appointments. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
AppointmentSettings(Action<ScheduleFieldsBuilder>)
It stores the dataSource collection and the fields related to appointments.
Declaration
public SchedulePropertiesBuilder AppointmentSettings(Action<ScheduleFieldsBuilder> appointmentSettings)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<ScheduleFieldsBuilder> | appointmentSettings | It accept the dataSource collection and the fields related to appointments. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
AppointmentTemplateId(String)
This field stores the appointment template value.
Declaration
public SchedulePropertiesBuilder AppointmentTemplateId(string appointmentTemplateId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | appointmentTemplateId | It accepts the appointment template value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
BlockoutSettings(Action<BlockoutSettingsBuilder>)
It stores all the options related to blockout settings of the Schedule.
Declaration
public SchedulePropertiesBuilder BlockoutSettings(Action<BlockoutSettingsBuilder> blockoutSettings)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<BlockoutSettingsBuilder> | blockoutSettings | It accept all the options related to blockout settings of the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
BusinessEndHour()
This field stores the default businesses end hour value.
Declaration
public SchedulePropertiesBuilder BusinessEndHour()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
BusinessEndHour(Int32)
This field stores the business end hour value.
Declaration
public SchedulePropertiesBuilder BusinessEndHour(int businessEndHour)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | businessEndHour | It accepts the business the end hour value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
BusinessStartHour()
This field stores the default business start hour value.
Declaration
public SchedulePropertiesBuilder BusinessStartHour()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
BusinessStartHour(Int32)
This field stores the business start hour value.
Declaration
public SchedulePropertiesBuilder BusinessStartHour(int businessStartHour)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | businessStartHour | It accepts the business the start hour value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
CategorizeSettings(Action<CategorizeSettingsBuilder>)
It stores various categorize colors to the Schedule appointments to differentiate it.
Declaration
public SchedulePropertiesBuilder CategorizeSettings(Action<CategorizeSettingsBuilder> categorizeSettings)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<CategorizeSettingsBuilder> | categorizeSettings | It accept the various categorize colors to the Schedule appointments to differentiate it. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
CellHeight(String)
This field stores the cell height value.
Declaration
public SchedulePropertiesBuilder CellHeight(string cellHeight)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | cellHeight | It accepts the cell height value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
CellWidth(String)
This field stores the cell width value.
Declaration
public SchedulePropertiesBuilder CellWidth(string cellWidth)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | cellWidth | It accepts the cell width value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ContextMenuSettings(Action<ContextMenuSettingsBuilder>)
It stores all the options related to the Scheduler context menu settings.
Declaration
public SchedulePropertiesBuilder ContextMenuSettings(Action<ContextMenuSettingsBuilder> scheduleContextMenu)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<ContextMenuSettingsBuilder> | scheduleContextMenu | It accept all the options related to the context menu settings of Scheduler. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
CssClass(String)
This field stores the custom CSS class name that defines specific user-defined styles and themes to be applied for partial or complete elements of the Schedule.
Declaration
public SchedulePropertiesBuilder CssClass(string cssClass)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | cssClass | It accepts the custom CSS class name that defines specific user-defined styles and themes to be applied for partial or complete elements of the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
CurrentDate(DateTime)
This field stores the current date value.
Declaration
public SchedulePropertiesBuilder CurrentDate(DateTime currentDate)Parameters
| Type | Name | Description |
|---|---|---|
| System.DateTime | currentDate | It accepts the date value in DateTime format. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
CurrentDate(String)
This field stores the current date value in String format.
Declaration
public SchedulePropertiesBuilder CurrentDate(string currentDate)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | currentDate | It accepts the date value in String format. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
CurrentView(CurrentView)
This field stores the view name which needs to be displayed on the initial loading of the Schedule.
Declaration
public SchedulePropertiesBuilder CurrentView(CurrentView currentView)Parameters
| Type | Name | Description |
|---|---|---|
| CurrentView | currentView | It accepts the view name which needs to be displayed on the initial loading of the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
DateFormat(String)
This field stores the Schedule date format value.
Declaration
public SchedulePropertiesBuilder DateFormat(string dateFormat)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | dateFormat | It accepts the Schedule date format value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
DateHeaderTemplateId(String)
This field stores the dateHeader template value.
Declaration
public SchedulePropertiesBuilder DateHeaderTemplateId(string dateHeaderTemplateId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | dateHeaderTemplateId | It accepts the the dateHeader template value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EnableAppointmentNavigation()
This field stores the value which indicates whether to shows the previous/next appointment navigator button on the Scheduler or not.
Declaration
public SchedulePropertiesBuilder EnableAppointmentNavigation()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EnableAppointmentNavigation(Boolean)
This field stores the value which indicates whether to shows the previous/next appointment navigator button on the Scheduler or not.
Declaration
public SchedulePropertiesBuilder EnableAppointmentNavigation(bool enableAppointmentNavigation)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | enableAppointmentNavigation | It accept the value which indicates whether to shows the previous/next appointment navigator button on the Scheduler or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EnableAppointmentResize()
This field stores the value which indicates whether to allow appointments to be resized or not.
Declaration
public SchedulePropertiesBuilder EnableAppointmentResize()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EnableAppointmentResize(Boolean)
This field stores the value which indicates whether to enables the resize behavior of appointments within the Schedule or not.
Declaration
public SchedulePropertiesBuilder EnableAppointmentResize(bool enableAppointmentResize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | enableAppointmentResize | It accept the value which indicates whether to enables the resize behavior of appointments within the Schedule or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EnableLoadOnDemand()
This field stores the value which indicates whether to enable the loading of Schedule appointments based on requirement.
Declaration
public SchedulePropertiesBuilder EnableLoadOnDemand()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EnableLoadOnDemand(Boolean)
This field stores the value which indicates whether to enable the loading of Schedule appointments based on requirement
Declaration
public SchedulePropertiesBuilder EnableLoadOnDemand(bool loadOnDemand)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | loadOnDemand | It accepts the value which indicates whether to enable the loading of Schedule appointments based on requirement. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EnablePersistence()
This field stores the current model value to the browser cookies for state maintenance. When the page gets refreshed, Schedule control values are retained.
Declaration
public SchedulePropertiesBuilder EnablePersistence()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder | This method returns boolean value |
EnablePersistence(Boolean)
This field stores the current model value to the browser cookies for state maintenance. When the page gets refreshed, Schedule control values are retained.
Declaration
public SchedulePropertiesBuilder EnablePersistence(bool enablePersistence)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | enablePersistence | It accept the current model value to the browser cookies for state maintenance. When the page gets refreshed, Schedule control values are retained. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder | This method returns boolean value |
EnableRecurrenceValidation()
This field stores the value which indicates whether to allow the validation of recurrence pattern to take place in Schedule or not.
Declaration
public SchedulePropertiesBuilder EnableRecurrenceValidation()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EnableRecurrenceValidation(Boolean)
This field stores the value which indicates whether to allow the validation of recurrence pattern to take place in Schedule or not.
Declaration
public SchedulePropertiesBuilder EnableRecurrenceValidation(bool enableRecurrenceValidation)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | enableRecurrenceValidation | It accepts the value which indicates whether to allow the validation of recurrence pattern to take place in Schedule or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EnableResize()
This field stores the value which indicates whether to allow appointments to be resized or not.
Declaration
public SchedulePropertiesBuilder EnableResize()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EnableResize(Boolean)
This field stores the value which indicates whether to allow appointments to be resized or not.
Declaration
public SchedulePropertiesBuilder EnableResize(bool enableResize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | enableResize | It accepts the value which indicates whether to allow appointments to be resized or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EnableRTL()
This field stores the value which indicates whether to enable RTL mode in Schedule.
Declaration
public SchedulePropertiesBuilder EnableRTL()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EnableRTL(Boolean)
This field stores the value which indicates whether to enable RTL mode in Schedule.
Declaration
public SchedulePropertiesBuilder EnableRTL(bool rtl)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | rtl | It accepts the value which indicates whether to enable RTL mode in Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EndHour()
This field stores the default Schedule end hour value.
Declaration
public SchedulePropertiesBuilder EndHour()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
EndHour(Int32)
This field stores the Schedule end hour value.
Declaration
public SchedulePropertiesBuilder EndHour(int endHour)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | endHour | It accepts the Schedule end hour value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
FirstDayOfWeek(DayOfWeek)
This field stores the specific day as the starting day of the week.
Declaration
public SchedulePropertiesBuilder FirstDayOfWeek(DayOfWeek firstDayOfWeek)Parameters
| Type | Name | Description |
|---|---|---|
| System.DayOfWeek | firstDayOfWeek | It accepts the specific day as the starting day of the week. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
Group(Action<GroupBuilder>)
It stores the array of resource names to be grouped on the Schedule.
Declaration
public SchedulePropertiesBuilder Group(Action<GroupBuilder> group)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<GroupBuilder> | group | It accept the array of resource names to be grouped on the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
Height(String)
This field stores the Schedule height value.
Declaration
public SchedulePropertiesBuilder Height(string height)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | height | It accepts the Schedule height value.. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
HighlightBusinessHours()
This field stores the default value which indicates to highlight the business hours.
Declaration
public SchedulePropertiesBuilder HighlightBusinessHours()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
HighlightBusinessHours(Boolean)
This field stores the value which indicates whether to highlight the business hours or not.
Declaration
public SchedulePropertiesBuilder HighlightBusinessHours(bool highlightBusinessHours)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | highlightBusinessHours | It accepts the value which indicates whether to highlight the business hours or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
IsDST(Boolean)
This field stores the value which indicates whether to allow the Schedule to observe Daylight Saving Time for supported timezones or not.
Declaration
public SchedulePropertiesBuilder IsDST(bool isDST)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | isDST | It accepts the value which indicates whether to allow the Schedule to observe Daylight Saving Time for supported timezones or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
IsResponsive()
This field stores the value which indicates whether to adapts the Schedule layout to fit the device screen size or not.
Declaration
public SchedulePropertiesBuilder IsResponsive()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
IsResponsive(Boolean)
This field stores the value which indicates whether to adapts the Schedule layout to fit the device screen size or not.
Declaration
public SchedulePropertiesBuilder IsResponsive(bool isResponsive)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | isResponsive | It accepts the value which indicates whether to adapts the Schedule layout to fit the device screen size or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
Locale(String)
This field stores the specific culture value of the Schedule.
Declaration
public SchedulePropertiesBuilder Locale(string localization)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | localization | It accepts the specific culture value of the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
MaxDate(DateTime)
This field stores the maximum date value to be displayed on the Schedule.
Declaration
public SchedulePropertiesBuilder MaxDate(DateTime maxDate)Parameters
| Type | Name | Description |
|---|---|---|
| System.DateTime | maxDate | It accepts the maximum date value in DateTime format to be displayed on the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
MaxDate(String)
This field stores the maximum date value to be displayed on the Schedule in String format.
Declaration
public SchedulePropertiesBuilder MaxDate(string maxDate)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | maxDate | It accepts the maximum date value in String format to be displayed on the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
MinDate(DateTime)
This field stores the minimum date value to be displayed on the Schedule.
Declaration
public SchedulePropertiesBuilder MinDate(DateTime minDate)Parameters
| Type | Name | Description |
|---|---|---|
| System.DateTime | minDate | It accepts the minimum date value in DateTime format to be displayed on the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
MinDate(String)
This field stores the minimum date value to be displayed on the Schedule in String format.
Declaration
public SchedulePropertiesBuilder MinDate(string minDate)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | minDate | It accepts the minimum date value in String format to be displayed on the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
Orientation(Orientation)
This field stores the orientation value.
Declaration
public SchedulePropertiesBuilder Orientation(Orientation orientation)Parameters
| Type | Name | Description |
|---|---|---|
| Orientation | orientation | It accepts the orientation value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
PrioritySettings(Action<PrioritySettingsBuilder>)
It stores all the options related to priority settings of the Schedule.
Declaration
public SchedulePropertiesBuilder PrioritySettings(Action<PrioritySettingsBuilder> prioritySettings)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<PrioritySettingsBuilder> | prioritySettings | It accept all the options related to priority settings of the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ReadOnly()
This field stores the value which indicates whether to disable the interaction with the Schedule appointments or not.
Declaration
public SchedulePropertiesBuilder ReadOnly()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ReadOnly(Boolean)
This field stores the value which indicates whether to disable the interaction with the Schedule appointments or not.
Declaration
public SchedulePropertiesBuilder ReadOnly(bool readOnly)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | readOnly | It accepts the value which indicates whether to disable the interaction with the Schedule appointments or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ReminderSettings(Action<ReminderSettingsBuilder>)
It stores all the options related to the reminder settings of Scheduler.
Declaration
public SchedulePropertiesBuilder ReminderSettings(Action<ReminderSettingsBuilder> reminderOptions)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<ReminderSettingsBuilder> | reminderOptions | It accept all the options related to the reminder settings of Scheduler |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
Render()
It creates Schedule control.
Declaration
public void Render()RenderDates(Action<ScheduleRenderDatesBuilder>)
It stores the specific start and end dates to be rendered in the Schedule control.
Declaration
public SchedulePropertiesBuilder RenderDates(Action<ScheduleRenderDatesBuilder> renderDates)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<ScheduleRenderDatesBuilder> | renderDates | It accept the specific start and end dates to be rendered in the Schedule control. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
RenderDates(List<Object>)
It stores the specific start and end dates to be rendered in the Schedule control.
Declaration
public SchedulePropertiesBuilder RenderDates(List<object> customDates)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<System.Object> | customDates |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ResourceHeaderTemplateId(String)
This field stores the resourceHeader template value.
Declaration
public SchedulePropertiesBuilder ResourceHeaderTemplateId(string resourceHeaderTemplateId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | resourceHeaderTemplateId | It accepts the resourceHeader template value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
Resources(Action<ResourcesBuilder>)
It stores all the options related to the resources settings of Scheduler.
Declaration
public SchedulePropertiesBuilder Resources(Action<ResourcesBuilder> resource)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<ResourcesBuilder> | resource | It accept all the options related to the resources settings of Scheduler. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
Resources(List<Resources>)
This field stores all the options related to the resources settings of Scheduler.
Declaration
public SchedulePropertiesBuilder Resources(List<Resources> resource)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<Resources> | resource | It accept all the options related to the resources settings of Scheduler. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ScheduleClientSideEvents(Action<ScheduleClientSideEventsBuilder>)
This field stores all the available client side event names.
Declaration
public SchedulePropertiesBuilder ScheduleClientSideEvents(Action<ScheduleClientSideEventsBuilder> scheduleClientSideEvents)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<ScheduleClientSideEventsBuilder> | scheduleClientSideEvents | It accept all the available client side event names. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowAllDayRow()
This field stores the value which indicates whether to display the all-day row cells on the Schedule or not.
Declaration
public SchedulePropertiesBuilder ShowAllDayRow()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowAllDayRow(Boolean)
This field stores the value which indicates whether to display the all-day row cells on the Schedule or not.
Declaration
public SchedulePropertiesBuilder ShowAllDayRow(bool showAllDayRow)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showAllDayRow | It accepts the value which indicates whether to display the all-day row cells on the Schedule or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowAppointmentNavigator()
This field stores the value which indicates whether to shows the previous/next appointment navigator button on the Scheduler or not.
Declaration
public SchedulePropertiesBuilder ShowAppointmentNavigator()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowAppointmentNavigator(Boolean)
This field stores the value which indicates whether to shows the previous/next appointment navigator button on the Scheduler or not.
Declaration
public SchedulePropertiesBuilder ShowAppointmentNavigator(bool showAppointmentNavigator)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showAppointmentNavigator | It accept the value which indicates whether to shows the previous/next appointment navigator button on the Scheduler or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowCurrentTimeIndicator()
This field stores the value which indicates whether to displays the current time indicator on the Schedule or not.
Declaration
public SchedulePropertiesBuilder ShowCurrentTimeIndicator()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowCurrentTimeIndicator(Boolean)
This field stores the value which indicates whether to displays the current time indicator on the Schedule or not.
Declaration
public SchedulePropertiesBuilder ShowCurrentTimeIndicator(bool showCurrentTimeIndicator)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showCurrentTimeIndicator | It accept the value which indicates whether to displays the current time indicator on the Schedule or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowDeleteConfirmationDialog()
This field stores the value which indicates whether to show the delete confirmation dialog before deleting an appointment or not.
Declaration
public SchedulePropertiesBuilder ShowDeleteConfirmationDialog()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowDeleteConfirmationDialog(Boolean)
This field stores the value which indicates whether to show the delete confirmation dialog before deleting an appointment or not.
Declaration
public SchedulePropertiesBuilder ShowDeleteConfirmationDialog(bool ShowDeleteConfirmationDialog)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | ShowDeleteConfirmationDialog | It accepts the value which indicates whether to show the delete confirmation dialog before deleting an appointment or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowHeaderBar()
This field stores the value which indicates whether to displays the header bar on the Schedule or not.
Declaration
public SchedulePropertiesBuilder ShowHeaderBar()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowHeaderBar(Boolean)
This field stores the value which indicates whether to displays the header bar on the Schedule or not.
Declaration
public SchedulePropertiesBuilder ShowHeaderBar(bool showHeaderBar)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showHeaderBar | It accepts the value which indicates whether to displays the header bar on the Schedule or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowLocationField()
This field stores the value which indicates whether to displays the location field additionally on Schedule appointment window or not.
Declaration
public SchedulePropertiesBuilder ShowLocationField()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowLocationField(Boolean)
This field stores the value which indicates whether to displays the location field additionally on Schedule appointment window or not.
Declaration
public SchedulePropertiesBuilder ShowLocationField(bool showLocationField)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showLocationField | It accepts the value which indicates whether to displays the location field additionally on Schedule appointment window or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowNextPrevMonth()
This field stores the value which indicates whether to displays the other months days in the current month on the Schedule or not.
Declaration
public SchedulePropertiesBuilder ShowNextPrevMonth()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowNextPrevMonth(Boolean)
This field stores the value which indicates whether to displays the other months days in the current month on the Schedule or not.
Declaration
public SchedulePropertiesBuilder ShowNextPrevMonth(bool ShowNextPrevMonth)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | ShowNextPrevMonth | It accepts the value which indicates whether to displays the other months days in the current month on the Schedule or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowOverflowButton()
This field stores the value which indicates whether to allow the height of the work-cells to adjust automatically (either expand or collapse) based on the number of appointment count or not.
Declaration
public SchedulePropertiesBuilder ShowOverflowButton()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowOverflowButton(Boolean)
This field stores the value which indicates whether to allow the height of the work-cells to adjust automatically (either expand or collapse) based on the number of appointment count or not.
Declaration
public SchedulePropertiesBuilder ShowOverflowButton(bool showOverflowButton)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showOverflowButton |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowQuickWindow()
This field stores the value which indicates whether to displays the quick window for every single click made on the Schedule cells or appointments or not.
Declaration
public SchedulePropertiesBuilder ShowQuickWindow()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowQuickWindow(Boolean)
This field stores the value which indicates whether to displays the quick window for every single click made on the Schedule cells / appointments or not.
Declaration
public SchedulePropertiesBuilder ShowQuickWindow(bool showQuickWindow)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showQuickWindow | It accepts the value which indicates whether to displays the quick window for every single click made on the Schedule cells / appointments or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowTimeScale()
This field stores the value which indicates whether to show or hide the time slots in Schedule.
Declaration
public SchedulePropertiesBuilder ShowTimeScale()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowTimeScale(Boolean)
This field stores the value which indicates whether to show or hide the time slots in Schedule.
Declaration
public SchedulePropertiesBuilder ShowTimeScale(bool showTimeScale)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showTimeScale | It accepts the value which indicates whether to show or hide the time slots in Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowTimeZoneFields()
This field stores the value which indicates whether to displays the start and end timezone fields on the Schedule appointment window or not.
Declaration
public SchedulePropertiesBuilder ShowTimeZoneFields()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowTimeZoneFields(Boolean)
This field stores the value which indicates whether to displays the start and end timezone fields on the Schedule appointment window or not.
Declaration
public SchedulePropertiesBuilder ShowTimeZoneFields(bool showTimeZoneFields)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showTimeZoneFields | It accepts the value which indicates whether to displays the start and end timezone fields on the Schedule appointment window or not. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowWeekend()
This field stores the value which indicates whether to hide the weekend days on all the Scheduler views.
Declaration
public SchedulePropertiesBuilder ShowWeekend()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ShowWeekend(Boolean)
This field stores the value which indicates whether to hide the weekend days on all the Scheduler views.
Declaration
public SchedulePropertiesBuilder ShowWeekend(bool showWeekend)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | showWeekend | It accepts the value which indicates whether to hide the weekend days on all the Scheduler views. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
StartHour()
This field stores the default Schedule start hour value.
Declaration
public SchedulePropertiesBuilder StartHour()Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
StartHour(Int32)
This field stores the Schedule start hour value.
Declaration
public SchedulePropertiesBuilder StartHour(int startHour)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | startHour | It accepts the Schedule start hour value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
TimeMode(TimeMode)
This field stores the 12 or 24 hour time mode value.
Declaration
public SchedulePropertiesBuilder TimeMode(TimeMode timeMode)Parameters
| Type | Name | Description |
|---|---|---|
| TimeMode | timeMode | It accepts the 12 or 24 hour time mode value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
TimeScale(Action<TimeScaleBuilder>)
It stores all the options related to the time scale of Scheduler. The timeslots either major or minor slots can be customized with this property.
Declaration
public SchedulePropertiesBuilder TimeScale(Action<TimeScaleBuilder> timeScale)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<TimeScaleBuilder> | timeScale | It accept all the options related to the time scale of Scheduler. The timeslots either major or minor slots can be customized with this property. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
TimeZone(String)
This field stores the timezone value.
Declaration
public SchedulePropertiesBuilder TimeZone(string timeZone)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | timeZone | It accepts the timezone value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
TimeZoneCollection(Action<TimezoneCollectionBuilder>)
It stores the collection of timezone items to be bound to the Schedule.
Declaration
public SchedulePropertiesBuilder TimeZoneCollection(Action<TimezoneCollectionBuilder> timezoneCollection)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<TimezoneCollectionBuilder> | timezoneCollection | It accept the collection of timezone items to be bound to the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
TimeZoneInfo(TimeZoneInfo)
This field stores the timezone information value.
Declaration
public SchedulePropertiesBuilder TimeZoneInfo(TimeZoneInfo timeZoneInfo)Parameters
| Type | Name | Description |
|---|---|---|
| System.TimeZoneInfo | timeZoneInfo | It accepts the timezone information value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
ToHtmlString()
It converts the Schedule properties into Html elements.
Declaration
public string ToHtmlString()Returns
| Type | Description |
|---|---|
| System.String | It returns the Schedule properties as Html elements. |
TooltipSettings(Action<ToolTipSettingsBuilder>)
It stores all the options related to tooltip settings of the Schedule.
Declaration
public SchedulePropertiesBuilder TooltipSettings(Action<ToolTipSettingsBuilder> tooltipSettings)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<ToolTipSettingsBuilder> | tooltipSettings | It accept all the options related to tooltip settings of the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
Views(List<String>)
This field stores the view collection to be displayed on the Schedule.
Declaration
public SchedulePropertiesBuilder Views(List<string> views)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<System.String> | views | It accepts the view collection to be displayed on the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
Width(String)
This field stores the Schedule width value.
Declaration
public SchedulePropertiesBuilder Width(string width)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | width | It accepts the Schedule width value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
WorkCellsTemplateId(String)
This field stores the workCells template value.
Declaration
public SchedulePropertiesBuilder WorkCellsTemplateId(string workCellsTemplateId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | workCellsTemplateId | It accepts the workCells template value. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
WorkHours(Action<WorkHoursBuilder>)
It stores all the options related to workhour settings of the Schedule.
Declaration
public SchedulePropertiesBuilder WorkHours(Action<WorkHoursBuilder> businessHours)Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<WorkHoursBuilder> | businessHours | It accept all the options related to workhour settings of the Schedule. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |
WorkWeek(List<String>)
This field stores the different day collection within workWeek view.
Declaration
public SchedulePropertiesBuilder WorkWeek(List<string> workWeek)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<System.String> | workWeek | It accepts the different day collection within workWeek view. |
Returns
| Type | Description |
|---|---|
| SchedulePropertiesBuilder |