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 to this section

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.

AppointmentResizeLink to this section

Gets or sets the appointment resize event callback.

Declaration
public EventCallback<SchedulerAppointmentResizeEventArgs> AppointmentResize { get; set; }
Property Value
Type Description
EventCallback<SchedulerAppointmentResizeEventArgs>Gets or sets the appointment resize event callback.

CultureLink to this section

Gets or sets the culture.

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

CurrentDateLink to this section

Gets or sets the current date.

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

HeightLink to this section

Gets the height.

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

ResourcesLink to this section

Gets the resource types of the scheduler in order of declaration. Views use them when grouping appointments by resource.

Declaration
public IList<RadzenSchedulerResource> Resources { get; }
Property Value
Type Description
IList<RadzenSchedulerResource>Gets the resource types of the scheduler in order of declaration. Views use them when grouping appointments by resource.

UICultureLink to this section

Gets the UI culture used for localized strings. Defaults to Culture.

Declaration
public Globalization.CultureInfo UICulture { get; }
Property Value
Type Description
Globalization.CultureInfoGets the UI culture used for localized strings. Defaults to Culture.

Methods

AddResourceLink to this section

Adds a resource type. Called when a RadzenSchedulerResource is initialized.

Declaration
public virtual Task AddResource(RadzenSchedulerResource resource)
Parameters
Type Name Description
RadzenSchedulerResource resource The resource type to add.
Returns
Type Description
Task

AddViewLink to this section

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 to this section

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 to this section

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 to this section

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.

GetSlotAttributesLink to this section

Gets the slot HTML attributes.

Declaration
public virtual IDictionary<string, object> GetSlotAttributes(DateTime start, DateTime end, Func<IEnumerable<AppointmentData>> getAppointments, IDictionary<string, object> resources)
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.
IDictionary<string, object> resources
Returns
Type Description
IDictionary<string, object>A dictionary containing the HTML attributes for the specified slot.

HasAppointmentMoveDelegateLink to this section

Returns true if the scheduler has an AppointmentMove listener.

Declaration
public abstract bool HasAppointmentMoveDelegate()
Returns
Type Description
bool

HasAppointmentResizeDelegateLink to this section

Returns true if the scheduler has an AppointmentResize listener.

Declaration
public virtual bool HasAppointmentResizeDelegate()
Returns
Type Description
bool

HasMouseEnterAppointmentDelegateLink to this section

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

Declaration
public abstract bool HasMouseEnterAppointmentDelegate()
Returns
Type Description
bool

IsAppointmentInRangeLink to this section

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 to this section

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 to this section

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 to this section

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 to this section

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 to this section

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 to this section

Reloads this instance.

Declaration
public abstract Task Reload()
Returns
Type Description
Task

RemoveResourceLink to this section

Removes a resource type. Called when a RadzenSchedulerResource is disposed.

Declaration
public virtual void RemoveResource(RadzenSchedulerResource resource)
Parameters
Type Name Description
RadzenSchedulerResource resource The resource type to remove.

RemoveViewLink to this section

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 to this section

Renders the appointment.

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

SelectAppointmentLink to this section

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 to this section

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 to this section

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 to this section

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 to this section

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 to this section

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>

SelectSlotLink to this section

Selects the specified slot.

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