Interface IScheduler

Namespace

Radzen.Blazor

Assembly

Radzen.Blazor.dll

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

public interface IScheduler

Properties

AppointmentMove

Gets or sets the appointment move event callback.

EventCallback<SchedulerAppointmentMoveEventArgs> AppointmentMove { get; set; }

Property Value

EventCallback<SchedulerAppointmentMoveEventArgs>

The appointment move event callback.

Culture

Gets or sets the culture.

CultureInfo Culture { get; set; }

Property Value

CultureInfo

The culture.

CurrentDate

Gets or sets the current date.

DateTime CurrentDate { get; set; }

Property Value

DateTime

The current date.

Height

Gets the height.

double Height { get; }

Property Value

double

The height.

Methods

AddView(ISchedulerView)

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

Task AddView(ISchedulerView view)

Parameters

view ISchedulerView

The view to add.

Returns

Task

GetAppointmentAttributes(AppointmentData)

Gets the appointment HTML attributes.

IDictionary<string, object> GetAppointmentAttributes(AppointmentData item)

Parameters

item AppointmentData

The appointment.

Returns

IDictionary<string, object>

A dictionary containing the HTML attributes for the specified appointment.

GetAppointmentsInRange(DateTime, DateTime)

Gets the appointments in the specified range.

IEnumerable<AppointmentData> GetAppointmentsInRange(DateTime start, DateTime end)

Parameters

start DateTime

The start of the range.

end DateTime

The end of the range.

Returns

IEnumerable<AppointmentData>

A collection of appointments within the specified range.

GetSlotAttributes(DateTime, DateTime)

Gets the slot HTML attributes.

IDictionary<string, object> GetSlotAttributes(DateTime start, DateTime end)

Parameters

start DateTime

The start of the slot.

end DateTime

The end of the slot.

Returns

IDictionary<string, object>

A dictionary containing the HTML attributes for the specified slot.

HasAppointmentMoveDelegate()

Returns true if the scheduler has an AppointmentMove listener.

bool HasAppointmentMoveDelegate()

Returns

bool

HasMouseEnterAppointmentDelegate()

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

bool HasMouseEnterAppointmentDelegate()

Returns

bool

IsAppointmentInRange(AppointmentData, DateTime, DateTime)

Determines whether an appointment is within the specified range.

bool IsAppointmentInRange(AppointmentData item, DateTime start, DateTime end)

Parameters

item AppointmentData

The appointment to check.

start DateTime

The start of the range.

end DateTime

The end of the range.

Returns

bool

true if the appointment is within the specified range; otherwise, false.

IsSelected(ISchedulerView)

Determines whether the specified view is selected.

bool IsSelected(ISchedulerView view)

Parameters

view ISchedulerView

The view.

Returns

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.

Task MouseEnterAppointment(ElementReference reference, AppointmentData data)

Parameters

reference ElementReference

data AppointmentData

Returns

Task

MouseLeaveAppointment(ElementReference, AppointmentData)

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

Task MouseLeaveAppointment(ElementReference reference, AppointmentData data)

Parameters

reference ElementReference

data AppointmentData

Returns

Task

Reload()

Reloads this instance.

Task Reload()

Returns

Task

RemoveView(ISchedulerView)

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

void RemoveView(ISchedulerView view)

Parameters

view ISchedulerView

The view to remove.

RenderAppointment(AppointmentData)

Renders the appointment.

RenderFragment RenderAppointment(AppointmentData item)

Parameters

item AppointmentData

The item.

Returns

RenderFragment

RenderFragment.

SelectAppointment(AppointmentData)

Selects the specified appointment.

Task SelectAppointment(AppointmentData data)

Parameters

data AppointmentData

The appointment to select.

Returns

Task

SelectMonth(DateTime, IEnumerable<AppointmentData>)

Selects the specified month.

Task SelectMonth(DateTime monthStart, IEnumerable<AppointmentData> appointments)

Parameters

monthStart DateTime

The start of the month.

appointments IEnumerable<AppointmentData>

The appointments for this range.

Returns

Task

SelectMore(DateTime, DateTime, IEnumerable<AppointmentData>)

Selects the specified more link.

Task<bool> SelectMore(DateTime start, DateTime end, IEnumerable<AppointmentData> appointments)

Parameters

start DateTime

The start.

end DateTime

The end.

appointments IEnumerable<AppointmentData>

The appointments for this range.

Returns

Task<bool>

SelectSlot(DateTime, DateTime)

Selects the specified slot.

Task SelectSlot(DateTime start, DateTime end)

Parameters

start DateTime

The start.

end DateTime

The end.

Returns

Task

SelectSlot(DateTime, DateTime, IEnumerable<AppointmentData>)

Selects the specified slot.

Task<bool> SelectSlot(DateTime start, DateTime end, IEnumerable<AppointmentData> appointments)

Parameters

start DateTime

The start.

end DateTime

The end.

appointments IEnumerable<AppointmentData>

The appointments for this range.

Returns

Task<bool>