Interface ISchedule
An interface that holds properties of scheduler.
Namespace: Syncfusion.Blazor.Schedule
Assembly: Syncfusion.Blazor.dll
Syntax
public interface ISchedule
Properties
AgendaDaysCount
Sets the number of days to be displayed by default in Agenda View and in case of virtual scrolling, the number of days will be fetched on each scroll-end based on this count.
Declaration
int AgendaDaysCount { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
AllowDragAndDrop
When set to True
, allows the appointments to move over the time slots. When an appointment is dragged, both its start
and end time tends to change simultaneously allowing it to reschedule the appointment on some other time.
Declaration
bool AllowDragAndDrop { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowInline
This property helps user to add/edit the event in inline. By default, it is set to False
.
Declaration
bool AllowInline { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowKeyboardInteraction
When set to True
, allows the keyboard interaction to take place on Schedule.
Declaration
bool AllowKeyboardInteraction { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowMultiCellSelection
This property helps user to allow/prevent the selection of multiple cells.
By default, it is set to True
.
Declaration
bool AllowMultiCellSelection { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowMultiRowSelection
This property helps user to allow/prevent the selection of multiple days(rows).
By default, it is set to True
.
Declaration
bool AllowMultiRowSelection { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowResizing
When set to True
, allows the resizing of appointments. It allows the rescheduling of appointments either by changing the
start or end time by dragging the event resize handlers.
Declaration
bool AllowResizing { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
CssClass
It is used to customize the Schedule which accepts custom CSS class names that defines specific user-defined styles and themes to be applied on the Schedule element.
Declaration
string CssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CurrentView
To set the active view on scheduler, the currentView
property can be used and it usually accepts either of the following available
view options.The view option specified in this property will be initially loaded on the schedule.
- Day
- Week
- WorkWeek
- Month
- Year
- Agenda
- MonthAgenda
- TimelineDay
- TimelineWeek
- TimelineWorkWeek
- TimelineMonth
- TimelineYear.
Declaration
View CurrentView { get; set; }
Property Value
Type | Description |
---|---|
View |
DateFormat
By default, Schedule follows the date-format as per the default culture assigned to it.
It is also possible to manually set specific date format by using the dateFormat
property.
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
string DateFormat { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EnableAutoRowHeight
When set to True
, allows the height of the work-cells to adjust automatically
based on the number of appointments present in those time ranges.
Declaration
bool EnableAutoRowHeight { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
bool EnablePersistence { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableRecurrenceValidation
The recurrence validation will be done by default
When this property is set to False
, the recurrence validation will be skipped.
Declaration
bool EnableRecurrenceValidation { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
bool EnableRtl { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EndHour
It is used to specify the end hour, at which the Schedule ends. It too accepts the time string in a short skeleton format.
Declaration
string EndHour { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EventDragArea
It enables the external drag and drop support for appointments on scheduler, to be able to move them out of the scheduler layout. When the drag area is explicitly set with specific DOM element name, the appointments can be dragged anywhere within the specified drag area location.
Declaration
string EventDragArea { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EventSettings
Complete set of settings related to Schedule events to bind it to local or remote dataSource, map applicable database fields and other validation to be carried out on the available fields.
Declaration
IScheduleEventSettings EventSettings { get; set; }
Property Value
Type | Description |
---|---|
IScheduleEventSettings |
FirstDayOfWeek
This option allows the user to set the first day of a week on Schedule. It should be based on the locale set to it and each culture defines its own first day of week values.If needed, the user can set it manually on his own by defining the value through this property.It usually accepts the integer values, whereby 0 is always denoted as Sunday, 1 as Monday and so on.
Declaration
int FirstDayOfWeek { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
HeaderRows
Allows defining the collection of custom header rows to display the year, month, week, date and hour label as an individual row on the timeline view of the scheduler.
Declaration
List<ScheduleHeaderRow> HeaderRows { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<ScheduleHeaderRow> |
Height
Sets the height
of the Schedule component, accepting both string and number values.
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
string Height { get; set; }
Property Value
Type | Description |
---|---|
System.String |
HideEmptyAgendaDays
The days which does not has even a single event to display will be hidden from the UI of Agenda View by default.
When this property is set to False
, the empty dates will also be displayed on the Schedule.
Declaration
bool HideEmptyAgendaDays { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
MaxDate
To define the maximum date on the Schedule, maxDate
property can be defined.
Usually, it defaults to the new Date(2099, 11, 31).
Declaration
DateTime MaxDate { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
MinDate
To define the minimum date on the Schedule, minDate
property can be defined.
Usually, it defaults to the new Date(1900, 0, 1).
Declaration
DateTime MinDate { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
QuickInfoOnSelectionEnd
This property helps to show quick popup after multiple cell selection.
By default, it is set to False
.
Declaration
bool QuickInfoOnSelectionEnd { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
QuickInfoTemplates
The template option to customize the quick window. The three sections of the quick popup whereas the header, content, and footer can be easily customized with individual template option.
Declaration
ScheduleQuickInfoTemplates QuickInfoTemplates { get; set; }
Property Value
Type | Description |
---|---|
ScheduleQuickInfoTemplates |
Readonly
When set to True
, makes the Schedule to render in a read only mode. No CRUD actions will be allowed at this time.
Declaration
bool Readonly { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ResourceCollection
It contains the collection of resources to be displayed on the Schedule.
Declaration
List<Resource> ResourceCollection { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Resource> |
ResourceRowRef
It holds the resource row reference.
Declaration
ResourceRow ResourceRowRef { get; set; }
Property Value
Type | Description |
---|---|
Syncfusion.Blazor.Schedule.Internal.ResourceRow |
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.
Declaration
ScheduleGroup ScheduleGroup { get; set; }
Property Value
Type | Description |
---|---|
ScheduleGroup |
ScheduleResources
Allows defining the collection of resources to be displayed on the Schedule. The resource collection needs to be defined with unique resource names to identify it along with the respective dataSource and field mapping options.
Declaration
List<IScheduleResources> ScheduleResources { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<IScheduleResources> |
ScheduleTemplates
Template option to customize the scheduler.
Declaration
ScheduleTemplates ScheduleTemplates { get; set; }
Property Value
Type | Description |
---|---|
ScheduleTemplates |
SelectedDate
To mark the active (current) date on the Schedule, selectedDate
property can be defined.
Usually, it defaults to the current System date.
Declaration
DateTime SelectedDate { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
ShowHeaderBar
When set to False
, hides the header bar of the Schedule from UI. By default,
the header bar holds the date and view navigation options, to which the user can add their own custom items onto it.
Declaration
bool ShowHeaderBar { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ShowQuickInfo
When set to True
, displays a quick popup with cell or event details on single clicking over the cells or on events.
By default, it is set to True
.
Declaration
bool ShowQuickInfo { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ShowTimeIndicator
When set to False
, hides the current time indicator from the Schedule. Otherwise,
it visually depicts the live current system time appropriately on the user interface.
Declaration
bool ShowTimeIndicator { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ShowWeekend
When set to False
, it hides the weekend days of a week from the Schedule. The days which are not defined in the working days
collection are usually treated as weekend days.
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
bool ShowWeekend { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ShowWeekNumber
When set to True
, displays the week number of the current view date range.
By default, it is set to False
.
Declaration
bool ShowWeekNumber { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
StartHour
It is used to specify the starting hour, from which the Schedule starts to display. It accepts the time string in a short skeleton format and also, hides the time beyond the specified start time.
Declaration
string StartHour { get; set; }
Property Value
Type | Description |
---|---|
System.String |
TimeScale
Allows to set different time duration on Schedule along with the customized grid count. It also has template option to customize the time slots with required time values in its own format.
Declaration
ScheduleTimeScale TimeScale { get; set; }
Property Value
Type | Description |
---|---|
ScheduleTimeScale |
Timezone
Schedule will be assigned with specific timezone, so as to display the events in it accordingly. By default, Schedule dates are processed with System timezone, as no timezone will be assigned specifically to the Schedule at the initial time. Whenever the Schedule is bound to remote data services, it is always recommended to set specific timezone to Schedule to make the events on it to display on the same time irrespective of the system timezone.It usually accepts the valid[IANA] (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) timezone names.
Declaration
string Timezone { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Width
Sets the width
of the Schedule component, accepting both string and number values.
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
string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String |
WorkDays
It is used to set the working days on Schedule. The only days that are defined in this collection will be rendered on the workWeek
view whereas on other views, it will display all the usual days and simply highlights the working days with different shade.
Declaration
int[] WorkDays { get; set; }
Property Value
Type | Description |
---|---|
System.Int32[] |
WorkHours
The working hours should be highlighted on Schedule with different color shade and an additional option must be provided to
highlight it or not.This functionality is handled through workHours
property and the start work hour should be 9 AM by default
and end work hour should point to 6 PM.The start and end working hours needs to be provided as Time value of short skeleton type.
Declaration
ScheduleWorkHours WorkHours { get; set; }
Property Value
Type | Description |
---|---|
ScheduleWorkHours |
Methods
GetCurrentAction()
Retrives the current action of the scheduler.
Declaration
CurrentAction GetCurrentAction()
Returns
Type | Description |
---|---|
CurrentAction | The current action of the scheduler. |
GetCurrentViewDates()
Retrieves the dates that lies on active view of Scheduler.
Declaration
List<DateTime> GetCurrentViewDates()
Returns
Type | Description |
---|---|
System.Collections.Generic.List<System.DateTime> | List of dates. |
GetResourceCollections()
Retrieves the resource collection available in the scheduler.
Declaration
List<Resource> GetResourceCollections()
Returns
Type | Description |
---|---|
System.Collections.Generic.List<Resource> | The resource collections available in the scheduler. |
PropertyChanged()
Called internally, if any of the property value changed.
Declaration
Task PropertyChanged()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Task. |
UpdateChildProperties(String, Object)
It will update the child properties.
Declaration
void UpdateChildProperties(string key, object propertyValue)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | Key string to get the property value. |
System.Object | propertyValue | value object to get the property value. |