Interface ISchedule
An interface that represents the properties of a scheduler.
Namespace: Syncfusion.Blazor.Schedule
Assembly: Syncfusion.Blazor.dll
Syntax
public interface IScheduleProperties
AgendaDaysCount
Gets or sets the number of days to be displayed in Agenda View by default. When using virtual scrolling, this value determines the number of days that will be fetched on each scroll-end.
Declaration
int AgendaDaysCount { get; set; }Property Value
| Type |
|---|
| System.Int32 |
AllowClipboard
Enables clipboard functionality for appointments, allowing them to be copied using keyboard shortcuts and pasted onto the Scheduler.
When set to true, users can use keyboard shortcuts to cut, copy appointments and paste them into different time slots or calendars.
Declaration
bool AllowClipboard { get; set; }Property Value
| Type |
|---|
| System.Boolean |
AllowDragAndDrop
Gets or sets whether the scheduler appointments can be dragged and dropped over work cells.
Declaration
bool AllowDragAndDrop { get; set; }Property Value
| Type |
|---|
| System.Boolean |
AllowInline
Gets or sets the ability to create and edit appointments in-line in the scheduler.
Declaration
bool AllowInline { get; set; }Property Value
| Type |
|---|
| System.Boolean |
AllowKeyboardInteraction
Gets or sets the ability to use keyboard input in the scheduler.
Declaration
bool AllowKeyboardInteraction { get; set; }Property Value
| Type |
|---|
| System.Boolean |
AllowMultiCellSelection
Gets or sets the ability to select multiple cells in the scheduler.
Declaration
bool AllowMultiCellSelection { get; set; }Property Value
| Type |
|---|
| System.Boolean |
AllowMultiRowSelection
Gets or sets the ability to select multiple days (rows) in the scheduler.
Declaration
bool AllowMultiRowSelection { get; set; }Property Value
| Type |
|---|
| System.Boolean |
AllowOverlap
Gets or sets the appointments are getting overlapped or not.
Declaration
bool AllowOverlap { get; set; }Property Value
| Type |
|---|
| System.Boolean |
AllowResizing
Gets or sets the ability to resize appointments in the scheduler.
Declaration
bool AllowResizing { get; set; }Property Value
| Type |
|---|
| System.Boolean |
CssClass
Gets or sets the custom classes to customize the schedule component.
Declaration
string CssClass { get; set; }Property Value
| Type |
|---|
| System.String |
CurrentView
Gets or sets the current view on the scheduler. The specified view will be initially loaded.
Declaration
View CurrentView { get; set; }Property Value
| Type |
|---|
| View |
DateFormat
Gets or sets the date format that should be applied on header date range label and also in editor window.
Declaration
string DateFormat { get; set; }Property Value
| Type |
|---|
| System.String |
EnableAutoRowHeight
Gets or sets the ability to adjust the height of work cells based on the number of appointments in the time range.
Declaration
bool EnableAutoRowHeight { get; set; }Property Value
| Type |
|---|
| System.Boolean |
EnablePersistence
Gets or sets whether to persist component's state between page reloads. When set to true, the CurrentView and SelectedDate property is persisted.
Declaration
bool EnablePersistence { get; set; }Property Value
| Type |
|---|
| System.Boolean |
EnableRecurrenceValidation
Gets or sets the ability to perform recurrence validation.
Declaration
bool EnableRecurrenceValidation { get; set; }Property Value
| Type |
|---|
| System.Boolean |
EnableRtl
Gets or sets whether the right to left direction is enabled for schedule component.
Declaration
bool EnableRtl { get; set; }Property Value
| Type |
|---|
| System.Boolean |
EndHour
Gets or sets the time string in short skeleton format HH:mm, which represents the end of the schedule hour.
Declaration
string EndHour { get; set; }Property Value
| Type |
|---|
| System.String |
EventDragArea
Gets or sets the ability to enable external drag and drop support for appointments on the scheduler.
Declaration
string EventDragArea { get; set; }Property Value
| Type |
|---|
| System.String |
FirstDayOfWeek
Gets or sets the first day of the week.
Declaration
int FirstDayOfWeek { get; set; }Property Value
| Type |
|---|
| System.Int32 |
Height
Gets or sets the height of the schedule element in pixels/number/percentage.
Declaration
string Height { get; set; }Property Value
| Type |
|---|
| System.String |
HideEmptyAgendaDays
Gets or sets the ability to hide empty dates from the Agenda View of the scheduler.
Declaration
bool HideEmptyAgendaDays { get; set; }Property Value
| Type |
|---|
| System.Boolean |
MaxDate
Gets or sets the maximum date that can be displayed on the scheduler.
Declaration
DateTime MaxDate { get; set; }Property Value
| Type |
|---|
| System.DateTime |
MinDate
Gets or sets the minimum date that can be displayed on the scheduler.
Declaration
DateTime MinDate { get; set; }Property Value
| Type |
|---|
| System.DateTime |
QuickInfoOnSelectionEnd
Gets or sets the ability to show a quick popup after multiple cell selection via mouse interaction.
Declaration
bool QuickInfoOnSelectionEnd { get; set; }Property Value
| Type |
|---|
| System.Boolean |
Readonly
Gets or sets the ability to enable read-only mode on the scheduler.
Declaration
bool Readonly { get; set; }Property Value
| Type |
|---|
| System.Boolean |
SelectedDate
Gets or sets the currently selected date on the scheduler, based on which layout will be rendered.
Declaration
DateTime SelectedDate { get; set; }Property Value
| Type |
|---|
| System.DateTime |
ShowHeaderBar
Gets or sets the ability to hide the header bar on the scheduler.
Declaration
bool ShowHeaderBar { get; set; }Property Value
| Type |
|---|
| System.Boolean |
ShowQuickInfo
Gets or sets the ability to display a quick popup with cell or event details on single click.
Declaration
bool ShowQuickInfo { get; set; }Property Value
| Type |
|---|
| System.Boolean |
ShowTimeIndicator
Gets or sets the ability to hide the current time indicator on the scheduler.
Declaration
bool ShowTimeIndicator { get; set; }Property Value
| Type |
|---|
| System.Boolean |
ShowWeekend
Gets or sets whether non-working days are hidden from the scheduler.
Declaration
bool ShowWeekend { get; set; }Property Value
| Type |
|---|
| System.Boolean |
ShowWeekNumber
Gets or sets the ability to display the week number of the current view date range on the scheduler.
Declaration
bool ShowWeekNumber { get; set; }Property Value
| Type |
|---|
| System.Boolean |
StartHour
Gets or sets the time string in short skeleton format HH:mm, which represents the start of the schedule hour.
Declaration
string StartHour { get; set; }Property Value
| Type |
|---|
| System.String |
Timezone
Gets or sets the timezone to be applied on the scheduler.
Declaration
string Timezone { get; set; }Property Value
| Type |
|---|
| System.String |
Width
Gets or sets the width of the schedule element in pixels/number/percentage.
Declaration
string Width { get; set; }Property Value
| Type |
|---|
| System.String |
WorkDays
Gets or sets the working days on the schedule.
Declaration
int[] WorkDays { get; set; }Property Value
| Type |
|---|
| System.Int32[] |
Methods
GetCurrentAction()
Retrieves 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. |