SchedulerExtension.GetAppointmentsToRemove<T>(SchedulerSettings, FetchAppointmentsMethod, Object) Method

Obtains appointments which should be removed from the data source using the delegate method that enables you to dynamically limit the number of loaded appointments.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v24.1.dll

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public static T[] GetAppointmentsToRemove<T>(
    SchedulerSettings settings,
    FetchAppointmentsMethod fetchAppointmentsMethod,
    object resourceDataObject
)

VB.NET

Public Shared Function GetAppointmentsToRemove(Of T)(
    settings As SchedulerSettings,
    fetchAppointmentsMethod As FetchAppointmentsMethod,
    resourceDataObject As Object
) As T()

Parameters

Name	Type	Description
settings	SchedulerSettings	A SchedulerSettings object containing settings applied to the Scheduler.
fetchAppointmentsMethod	FetchAppointmentsMethod	A FetchAppointmentsMethod delegate that provides appointments to insert.
resourceDataObject	Object	A collection of resources in the scheduler.

Type Parameters

Name
T

Returns

Type	Description
T[]	A Model data class instance that is the entity contained in the appointment data source and mapped to an appointment.

Remarks

The GetAppointmentsToRemove<T> method instantiates a Scheduler and applies the specified settings. Then, an appointment being inserted is retrieved from this Scheduler instance.

For an example of use refer to the following code snippet.

View Example: Scheduler - How to implement the FetchAppointment event functionality

SchedulerPartial.cshtml

@Html.DevExpress().Scheduler(SchedulerSettingsHelper.CommonSchedulerSettings).Bind(Model.FetchAppointments, Model.Resources).GetHtml()

HomeController.cs

static void UpdateAppointment() {

    DBAppointment[] insertedAppt = SchedulerExtension.GetAppointmentsToInsert<DBAppointment>(SchedulerSettingsHelper.CommonSchedulerSettings,
        SchedulerDataHelper.FetchAppointmentsHelperMethod,
        SchedulerDataHelper.GetResources());
    foreach (var appt in insertedAppt) {
        SchedulerDataHelper.InsertAppointment(appt);
    }

    DBAppointment[] updatedAppt = SchedulerExtension.GetAppointmentsToUpdate<DBAppointment>(SchedulerSettingsHelper.CommonSchedulerSettings,
        SchedulerDataHelper.FetchAppointmentsHelperMethod,
        SchedulerDataHelper.GetResources());

    foreach (var appt in updatedAppt) {
        SchedulerDataHelper.UpdateAppointment(appt);
    }

    DBAppointment[] removedAppt = SchedulerExtension.GetAppointmentsToRemove<DBAppointment>(SchedulerSettingsHelper.CommonSchedulerSettings,
        SchedulerDataHelper.FetchAppointmentsHelperMethod, 
        SchedulerDataHelper.GetResources());
    foreach (var appt in removedAppt) {
        SchedulerDataHelper.RemoveAppointment(appt);
    }

}

HomeController.vb

Private Shared Sub UpdateAppointment()

    Dim insertedAppt() As DBAppointment = SchedulerExtension.GetAppointmentsToInsert(Of DBAppointment)(SchedulerSettingsHelper.CommonSchedulerSettings, AddressOf SchedulerDataHelper.FetchAppointmentsHelperMethod, SchedulerDataHelper.GetResources())
    For Each appt In insertedAppt
        SchedulerDataHelper.InsertAppointment(appt)
    Next appt

    Dim updatedAppt() As DBAppointment = SchedulerExtension.GetAppointmentsToUpdate(Of DBAppointment)(SchedulerSettingsHelper.CommonSchedulerSettings, AddressOf SchedulerDataHelper.FetchAppointmentsHelperMethod, SchedulerDataHelper.GetResources())

    For Each appt In updatedAppt
        SchedulerDataHelper.UpdateAppointment(appt)
    Next appt

    Dim removedAppt() As DBAppointment = SchedulerExtension.GetAppointmentsToRemove(Of DBAppointment)(SchedulerSettingsHelper.CommonSchedulerSettings, AddressOf SchedulerDataHelper.FetchAppointmentsHelperMethod, SchedulerDataHelper.GetResources())
    For Each appt In removedAppt
        SchedulerDataHelper.RemoveAppointment(appt)
    Next appt

End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetAppointmentsToRemove<T>(SchedulerSettings, FetchAppointmentsMethod, Object) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

asp-net-mvc-scheduler-fetch-appointment-event/CS/DevExpressMvcSchedulerFetchAppointments/Controllers/HomeController.cs#L44

DBAppointment[] removedAppt = SchedulerExtension.GetAppointmentsToRemove<DBAppointment>(SchedulerSettingsHelper.CommonSchedulerSettings,
    SchedulerDataHelper.FetchAppointmentsHelperMethod,

VB.NET

asp-net-mvc-scheduler-fetch-appointment-event/VB/DevExpressMvcSchedulerFetchAppointments/Controllers/HomeController.vb#L42

Dim removedAppt() As DBAppointment = SchedulerExtension.GetAppointmentsToRemove(Of DBAppointment)(SchedulerSettingsHelper.CommonSchedulerSettings, AddressOf SchedulerDataHelper.FetchAppointmentsHelperMethod, SchedulerDataHelper.GetResources())
For Each appt In removedAppt