Interface IScheduleDataProvider

Defines the framework for providing schedule item data to the ScheduleControl.

Namespace: Syncfusion.Schedule

Assembly: Syncfusion.Schedule.Base.dll

Syntax

public interface IScheduleDataProvider

Properties

IsDirty

Gets or sets a value indicating whether data source is modified or not.

Declaration

bool IsDirty { get; set; }

Property Value

Type
System.Boolean

SaveOnCloseBehaviorAction

Gets or sets the SaveOnCloseBehavioourAction which determines whether CommitChanges is called when the toplevel Form holding the ScheduleControl is closed.

Declaration

SaveOnCloseBehavior SaveOnCloseBehaviorAction { get; set; }

Property Value

Type
SaveOnCloseBehavior

Methods

AddItem(IScheduleAppointment)

Adds a schedule item to this list.

Declaration

void AddItem(IScheduleAppointment item)

Parameters

Type	Name	Description
IScheduleAppointment	item	The schedule item to be added.

CommitChanges()

Saves modifications to the schedule items back to the data store.

Declaration

void CommitChanges()

GetLabels()

Gets a list holding the possible values for the LabelValue property.

Declaration

ILookUpObjectList GetLabels()

Returns

Type	Description
ILookUpObjectList	A list of possible values.

GetLocations()

Gets a list holding the possible values for the LocationValue property.

Declaration

ILookUpObjectList GetLocations()

Returns

Type	Description
ILookUpObjectList	A list of possible values.

GetMarkers()

Gets a list holding the possible values for the MarkerValue property.

Declaration

ILookUpObjectList GetMarkers()

Returns

Type	Description
ILookUpObjectList	A list of possible values.

GetOwners()

Gets a list holding the possible values for the Owner property.

Declaration

IScheduleResourceList GetOwners()

Returns

Type	Description
IScheduleResourceList	Resources collection

GetReminders()

Gets a list holding the possible values for the ReminderValue property.

Declaration

ILookUpObjectList GetReminders()

Returns

Type	Description
ILookUpObjectList	A list of possible values.

GetSchedule(DateTime, DateTime)

Gets a list of schedule items for a range of dates.

Declaration

IScheduleAppointmentList GetSchedule(DateTime startDate, DateTime endDate)

Parameters

Type	Name	Description
System.DateTime	startDate	The start date of the requested range.
System.DateTime	endDate	The end date of the requested range.

Returns

Type	Description
IScheduleAppointmentList	IScheduleAppointmentList object that holds the list of schedule items.

GetSchedule(DateTime, DateTime, Int32)

Gets a list of schedule items for a range of dates and a specified owner.

Declaration

IScheduleAppointmentList GetSchedule(DateTime startDate, DateTime endDate, int owner)

Parameters

Type	Name	Description
System.DateTime	startDate	The start date of the requested range.
System.DateTime	endDate	The end date of the requested range.
System.Int32	owner	The requested owner.

Returns

Type	Description
IScheduleAppointmentList	IScheduleAppointmentList object that holds the list of schedule items.

GetScheduleForDay(DateTime)

Gets a list of schedule items for a particular day.

Declaration

IScheduleAppointmentList GetScheduleForDay(DateTime day)

Parameters

Type	Name	Description
System.DateTime	day	The requested date.

Returns

Type	Description
IScheduleAppointmentList	IScheduleAppointmentList object that holds the list of schedule items.

GetScheduleForDay(DateTime, Int32)

Gets a list of schedule items for a particular day and owner.

Declaration

IScheduleAppointmentList GetScheduleForDay(DateTime day, int owner)

Parameters

Type	Name	Description
System.DateTime	day	The requested date.
System.Int32	owner	The requested owner.

Returns

Type	Description
IScheduleAppointmentList	IScheduleAppointmentList object that holds the list of schedule items.

InitLists()

Initializes the contents of the ILookUpObjectList lists obtained from these methods: GetLocations(), GetMarkers(), GetLabels(), GetReminders(), GetOwners()

Declaration

void InitLists()

NewScheduleAppointment()

Gets an instance of a new schedule item.

Declaration

IScheduleAppointment NewScheduleAppointment()

Returns

Type	Description
IScheduleAppointment	A new schedule item that can be added to this list.

NewScheduleAppointmentList()

Gets an instance of a new schedule items collection.

Declaration

IScheduleAppointmentList NewScheduleAppointmentList()

Returns

Type	Description
IScheduleAppointmentList	A new schedule items collection.

NewScheduleResource()

Gets an instance of a new schedule resource.

Declaration

IScheduleResource NewScheduleResource()

Returns

Type	Description
IScheduleResource	A new schedule resource.

NewScheduleResourceList()

Gets an instance of a new schedule resources collection.

Declaration

IScheduleResourceList NewScheduleResourceList()

Returns

Type	Description
IScheduleResourceList	A new schedule resources collection.

RemoveItem(IScheduleAppointment)

Removes a schedule item from this list.

Declaration

void RemoveItem(IScheduleAppointment item)

Parameters

Type	Name	Description
IScheduleAppointment	item	The schedule item to be removed.

SaveModifiedItem(IScheduleAppointment, IScheduleAppointment)

Makes changes to appointments.

Declaration

void SaveModifiedItem(IScheduleAppointment appModifiedItem, IScheduleAppointment appOriginalItem)

Parameters

Type	Name	Description
IScheduleAppointment	appModifiedItem	The edited appointment.
IScheduleAppointment	appOriginalItem	The original appointment.