Interface IScheduler

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

Namespace: Radzen.Blazor

Assembly: Radzen.Blazor.dll

Syntax

public interface IScheduler

Properties

AppointmentMove

Gets or sets the appointment move event callback.

Declaration

EventCallback<SchedulerAppointmentMoveEventArgs> AppointmentMove { get; set; }

Property Value

Type	Description
EventCallback<SchedulerAppointmentMoveEventArgs>	The appointment move event callback.

Culture

Gets or sets the culture.

Declaration

CultureInfo Culture { get; set; }

Property Value

Type	Description
CultureInfo	The culture.

CurrentDate

Gets or sets the current date.

Declaration

DateTime CurrentDate { get; set; }

Property Value

Type	Description
DateTime	The current date.

Height

Gets the height.

Declaration

double Height { get; }

Property Value

Type	Description
double	The height.

Methods

AddView(ISchedulerView)

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

Declaration

Task AddView(ISchedulerView view)

Parameters

Type	Name	Description
ISchedulerView	view	The view to add.

Returns

Type	Description
Task

GetAppointmentAttributes(AppointmentData)

Gets the appointment HTML attributes.

Declaration

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.

GetAppointmentsInRange(DateTime, DateTime)

Gets the appointments in the specified range.

Declaration

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.

GetSlotAttributes(DateTime, DateTime, Func<IEnumerable<AppointmentData>>)

Gets the slot HTML attributes.

Declaration

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.

HasAppointmentMoveDelegate()

Returns true if the scheduler has an AppointmentMove listener.

Declaration

bool HasAppointmentMoveDelegate()

Returns

Type	Description
bool

HasMouseEnterAppointmentDelegate()

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

Declaration

bool HasMouseEnterAppointmentDelegate()

Returns

Type	Description
bool

IsAppointmentInRange(AppointmentData, DateTime, DateTime)

Determines whether an appointment is within the specified range.

Declaration

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
bool	true if the appointment is within the specified range; otherwise, false.

IsSelected(ISchedulerView)

Determines whether the specified view is selected.

Declaration

bool IsSelected(ISchedulerView view)

Parameters

Type	Name	Description
ISchedulerView	view	The view.

Returns

Type	Description
bool	true if the specified view is selected; otherwise, false.

MouseEnterAppointment(ElementReference, AppointmentData)

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

Declaration

Task MouseEnterAppointment(ElementReference reference, AppointmentData data)

Parameters

Type	Name	Description
ElementReference	reference
AppointmentData	data

Returns

Type	Description
Task

MouseLeaveAppointment(ElementReference, AppointmentData)

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

Declaration

Task MouseLeaveAppointment(ElementReference reference, AppointmentData data)

Parameters

Type	Name	Description
ElementReference	reference
AppointmentData	data

Returns

Type	Description
Task

Reload()

Reloads this instance.

Declaration

Task Reload()

Returns

Type	Description
Task

RemoveView(ISchedulerView)

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

Declaration

void RemoveView(ISchedulerView view)

Parameters

Type	Name	Description
ISchedulerView	view	The view to remove.

RenderAppointment(AppointmentData)

Renders the appointment.

Declaration

RenderFragment RenderAppointment(AppointmentData item)

Parameters

Type	Name	Description
AppointmentData	item	The item.

Returns

Type	Description
RenderFragment	RenderFragment.

SelectAppointment(AppointmentData)

Selects the specified appointment.

Declaration

Task SelectAppointment(AppointmentData data)

Parameters

Type	Name	Description
AppointmentData	data	The appointment to select.

Returns

Type	Description
Task

SelectDay(DateTime, IEnumerable<AppointmentData>)

Selects the specified day.

Declaration

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

SelectMonth(DateTime, IEnumerable<AppointmentData>)

Selects the specified month.

Declaration

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

SelectMore(DateTime, DateTime, IEnumerable<AppointmentData>)

Selects the specified more link.

Declaration

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>

SelectSlot(DateTime, DateTime)

Selects the specified slot.

Declaration

Task SelectSlot(DateTime start, DateTime end)

Parameters

Type	Name	Description
DateTime	start	The start.
DateTime	end	The end.

Returns

Type	Description
Task

SelectSlot(DateTime, DateTime, IEnumerable<AppointmentData>)

Selects the specified slot.

Declaration

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	The appointments for this range.

Returns

Type	Description
Task<bool>