IScheduler Interface

The common RadzenScheduler<T> API injected as a cascading parameter to is views.

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public interface IScheduler

Properties

AppointmentMovelink

Gets or sets the appointment move event callback.

Declaration
public EventCallback<SchedulerAppointmentMoveEventArgs> AppointmentMove { get; set; }
Property Value
Type Description
EventCallback<SchedulerAppointmentMoveEventArgs>Gets or sets the appointment move event callback.

Culturelink

Gets or sets the culture.

Declaration
public Globalization.CultureInfo Culture { get; set; }
Property Value
Type Description
Globalization.CultureInfoGets or sets the culture.

CurrentDatelink

Gets or sets the current date.

Declaration
public DateTime CurrentDate { get; set; }
Property Value
Type Description
DateTimeGets or sets the current date.

Heightlink

Gets the height.

Declaration
public double Height { get; }
Property Value
Type Description
doubleGets the height.

Methods

AddViewlink

Adds a view. Must be called when a ISchedulerView is initialized.

Declaration
public abstract Task AddView(ISchedulerView view)
Parameters
Type Name Description
ISchedulerView view The view to add.
Returns
Type Description
Task

GetAppointmentAttributeslink

Gets the appointment HTML attributes.

Declaration
public abstract IDictionary<string, object> GetAppointmentAttributes(AppointmentData item)
Parameters
Type Name Description
AppointmentData item The appointment.
Returns
Type Description
IDictionary<string, object>A dictionary containing the HTML attributes for the specified appointment.

GetAppointmentsInRangelink

Gets the appointments in the specified range.

Declaration
public abstract IEnumerable<AppointmentData> GetAppointmentsInRange(DateTime start, DateTime end)
Parameters
Type Name Description
DateTime start The start of the range.
DateTime end The end of the range.
Returns
Type Description
IEnumerable<AppointmentData>A collection of appointments within the specified range.

GetSlotAttributeslink

Gets the slot HTML attributes.

Declaration
public abstract IDictionary<string, object> GetSlotAttributes(DateTime start, DateTime end, Func<IEnumerable<AppointmentData>> getAppointments)
Parameters
Type Name Description
DateTime start The start of the slot.
DateTime end The end of the slot.
Func<IEnumerable<AppointmentData>> getAppointments Function to return appointments for this range.
Returns
Type Description
IDictionary<string, object>A dictionary containing the HTML attributes for the specified slot.

HasAppointmentMoveDelegatelink

Returns true if the scheduler has an AppointmentMove listener.

Declaration
public abstract bool HasAppointmentMoveDelegate()
Returns
Type Description
bool

HasMouseEnterAppointmentDelegatelink

Returns true if the scheduler has a mouse enter appointment listener.

Declaration
public abstract bool HasMouseEnterAppointmentDelegate()
Returns
Type Description
bool

IsAppointmentInRangelink

Determines whether an appointment is within the specified range.

Declaration
public abstract bool IsAppointmentInRange(AppointmentData item, DateTime start, DateTime end)
Parameters
Type Name Description
AppointmentData item The appointment to check.
DateTime start The start of the range.
DateTime end The end of the range.
Returns
Type Description
booltrue if the appointment is within the specified range; otherwise, false.

IsSelectedlink

Determines whether the specified view is selected.

Declaration
public abstract bool IsSelected(ISchedulerView view)
Parameters
Type Name Description
ISchedulerView view The view.
Returns
Type Description
booltrue if the specified view is selected; otherwise, false.

MouseEnterAppointmentlink

Notifies the scheduler that the user has moved the mouse over the specified appointment.

Declaration
public abstract Task MouseEnterAppointment(ElementReference reference, AppointmentData data)
Parameters
Type Name Description
ElementReference reference
AppointmentData data
Returns
Type Description
Task

MouseEnterAppointmentlink

Notifies the scheduler that the user has moved the mouse over the specified appointment.

Declaration
public virtual Task MouseEnterAppointment(ElementReference reference, AppointmentData data, double clientX, double clientY)
Parameters
Type Name Description
ElementReference reference
AppointmentData data
double clientX
double clientY
Returns
Type Description
Task

MouseLeaveAppointmentlink

Notifies the scheduler that the user has moved the mouse out of the specified appointment.

Declaration
public abstract Task MouseLeaveAppointment(ElementReference reference, AppointmentData data)
Parameters
Type Name Description
ElementReference reference
AppointmentData data
Returns
Type Description
Task

MouseLeaveAppointmentlink

Notifies the scheduler that the user has moved the mouse out of the specified appointment.

Declaration
public virtual Task MouseLeaveAppointment(ElementReference reference, AppointmentData data, double clientX, double clientY)
Parameters
Type Name Description
ElementReference reference
AppointmentData data
double clientX
double clientY
Returns
Type Description
Task

Reloadlink

Reloads this instance.

Declaration
public abstract Task Reload()
Returns
Type Description
Task

RemoveViewlink

Removes a view. Must be called when a ISchedulerView is disposed.

Declaration
public abstract void RemoveView(ISchedulerView view)
Parameters
Type Name Description
ISchedulerView view The view to remove.

RenderAppointmentlink

Renders the appointment.

Declaration
public abstract RenderFragment RenderAppointment(AppointmentData item)
Parameters
Type Name Description
AppointmentData item The item.
Returns
Type Description
RenderFragmentRenderFragment.

SelectAppointmentlink

Selects the specified appointment.

Declaration
public abstract Task SelectAppointment(AppointmentData data)
Parameters
Type Name Description
AppointmentData data The appointment to select.
Returns
Type Description
Task

SelectDaylink

Selects the specified day.

Declaration
public abstract Task SelectDay(DateTime day, IEnumerable<AppointmentData> appointments)
Parameters
Type Name Description
DateTime day The selected day.
IEnumerable<AppointmentData> appointments The appointments for this range.
Returns
Type Description
Task

SelectMonthlink

Selects the specified month.

Declaration
public abstract Task SelectMonth(DateTime monthStart, IEnumerable<AppointmentData> appointments)
Parameters
Type Name Description
DateTime monthStart The start of the month.
IEnumerable<AppointmentData> appointments The appointments for this range.
Returns
Type Description
Task

SelectMorelink

Selects the specified more link.

Declaration
public abstract Task<bool> SelectMore(DateTime start, DateTime end, IEnumerable<AppointmentData> appointments)
Parameters
Type Name Description
DateTime start The start.
DateTime end The end.
IEnumerable<AppointmentData> appointments The appointments for this range.
Returns
Type Description
Task<bool>

SelectSlotlink

Selects the specified slot.

Declaration
public abstract Task SelectSlot(DateTime start, DateTime end)
Parameters
Type Name Description
DateTime start The start.
DateTime end The end.
Returns
Type Description
Task

SelectSlotlink

Selects the specified slot.

Declaration
public abstract Task<bool> SelectSlot(DateTime start, DateTime end, IEnumerable<AppointmentData> appointments)
Parameters
Type Name Description
DateTime start The start.
DateTime end The end.
IEnumerable<AppointmentData> appointments
Returns
Type Description
Task<bool>
In This Article
An error has occurred. This app may no longer respond until reloaded. Reload 🗙