Interface IRecurringScheduleDataProvider

Implement this interface to support recurring appointment in your IScheduleDataProvider.

Namespace: Syncfusion.Schedule

Assembly: Syncfusion.Schedule.Base.dll

Syntax

public interface IRecurringScheduleDataProvider

Properties

RecurringList

Gets a list of recurring appointments.

Declaration

IScheduleAppointmentList RecurringList { get; }

Property Value

Type
IScheduleAppointmentList

Methods

AddNewRecurringAppointments(IRecurringScheduleAppointment, DateTime)

Initially adds recurring appointments to the data provider.

Declaration

void AddNewRecurringAppointments(IRecurringScheduleAppointment item, DateTime dateLimit)

Parameters

Type	Name	Description
IRecurringScheduleAppointment	item	The recurring appointment definition.
System.DateTime	dateLimit	The minimal date up to which all recurring appointments should be added.

Remarks

Use this method on the initial load to handle adding recurring appointments.

CheckAndAddIfNeededRecurringAppointments(DateTime)

Used after the initial load to add additional recurring appointments to the data provider.

Declaration

bool CheckAndAddIfNeededRecurringAppointments(DateTime date)

Parameters

Type	Name	Description
System.DateTime	date	The date to which recurring appointments need to be extended.

Returns

Type	Description
System.Boolean	True if dates were added.

Remarks

Dynamically provide appointments on demand as new dates are exposed.

GetUniqueID()

Returns a unique integer that serves to identify a recurring family of appointments.

Declaration

int GetUniqueID()

Returns

Type	Description
System.Int32	A unique integer.

RemoveRecurringAppointments(IRecurringScheduleAppointment)

Removes all occurrences the given appointment.

Declaration

bool RemoveRecurringAppointments(IRecurringScheduleAppointment item)

Parameters

Type	Name	Description
IRecurringScheduleAppointment	item	Recurring appointment form.

Returns

Type	Description
System.Boolean	True if the operation succeeds.

SaveModifiedRecurringAppointment(IRecurringScheduleAppointment, IRecurringScheduleAppointment, RecurringAppointmentEditAction)

Makes changes to appointments in a recurring sequence of appointments.

Declaration

void SaveModifiedRecurringAppointment(IRecurringScheduleAppointment modifiedItem, IRecurringScheduleAppointment originalItem, RecurringAppointmentEditAction action)

Parameters

Type	Name	Description
IRecurringScheduleAppointment	modifiedItem	The edited appointment.
IRecurringScheduleAppointment	originalItem	The un-edited appointment.
RecurringAppointmentEditAction	action	The requested edit action.