SchedulerExtension.GetAppointmentsToRemove<T>(String, Object, Object, MVCxAppointmentStorage, MVCxResourceStorage) Method

Obtains appointments which should be removed from the data source.

Namespace: DevExpress.Web.Mvc

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

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public static T[] GetAppointmentsToRemove<T>(
    string schedulerName,
    object appointmentDataObject,
    object resourceDataObject,
    MVCxAppointmentStorage appointmentStorage,
    MVCxResourceStorage resourceStorage
)

VB.NET

Public Shared Function GetAppointmentsToRemove(Of T)(
    schedulerName As String,
    appointmentDataObject As Object,
    resourceDataObject As Object,
    appointmentStorage As MVCxAppointmentStorage,
    resourceStorage As MVCxResourceStorage
) As T()

Parameters

Name	Type	Description
schedulerName	String	The name of a Scheduler as it is specified by the SettingsBase.Name property.
appointmentDataObject	Object	A collection of appointments in the scheduler.
resourceDataObject	Object	A collection of resources in the scheduler.
appointmentStorage	MVCxAppointmentStorage	An MVCxAppointmentStorage object that implements the appointment storage functionality and contains mappings.
resourceStorage	MVCxResourceStorage	An MVCxResourceStorage object that implements the resource storage functionality and contains mappings.

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 creates a fake Scheduler but does not apply all scheduler settings specified in the view, for better performance. Then, an appointment being inserted is retrieved from this Scheduler instance.

Example

View Example: Scheduler - Lesson 2 - Insert-Update-Delete appointment feature

Index.cshtml (C#)

@model MVCSchedulerEditable.Models.SchedulerDataObject

@Html.Partial("SchedulerPartial", Model)

Index.cshtml (VB.NET)

@model MVCSchedulerEditable.Models.SchedulerDataObject

@Html.Partial("SchedulerPartial", Model)

SchedulerPartial.cshtml (C#)

@*#region #SchedulerPartial*@
@Html.DevExpress().Scheduler(
settings => {
    settings.Name = "scheduler";
    settings.CallbackRouteValues = new { Controller = "Home", Action = "SchedulerPartial" };
    settings.EditAppointmentRouteValues = new { Controller = "Home", Action = "EditAppointment" };
    settings.Storage.Appointments.Assign(MVCSchedulerEditable.Models.SchedulerStorageProvider.DefaultAppointmentStorage);
    settings.Storage.Resources.Assign(MVCSchedulerEditable.Models.SchedulerStorageProvider.DefaultResourceStorage);

    settings.Storage.EnableReminders = true;

    settings.ActiveViewType = SchedulerViewType.FullWeek;
    settings.Views.FullWeekView.Styles.ScrollAreaHeight = 600;
    settings.Start = new DateTime(2015, 4, 18);

}).Bind(Model.Appointments, Model.Resources).GetHtml()
@*#endregion #SchedulerPartial*@

SchedulerPartial.cshtml (VB.NET)

@*#region #SchedulerPartial*@
@Html.DevExpress().Scheduler(
settings => {
    settings.Name = "scheduler";
    settings.CallbackRouteValues = new { Controller = "Home", Action = "SchedulerPartial" };
    settings.EditAppointmentRouteValues = new { Controller = "Home", Action = "EditAppointment" };
    settings.Storage.Appointments.Assign(MVCSchedulerEditable.Models.SchedulerStorageProvider.DefaultAppointmentStorage);
    settings.Storage.Resources.Assign(MVCSchedulerEditable.Models.SchedulerStorageProvider.DefaultResourceStorage);

    settings.Storage.EnableReminders = true;

    settings.ActiveViewType = SchedulerViewType.FullWeek;
    settings.Views.FullWeekView.Styles.ScrollAreaHeight = 600;
    settings.Start = new DateTime(2015, 4, 18);

}).Bind(Model.Appointments, Model.Resources).GetHtml()
@*#endregion #SchedulerPartial*@

HomeController.cs

public ActionResult EditAppointment()
{
    UpdateAppointment();
    return PartialView("SchedulerPartial", SchedulerDataHelper.DataObject);
}

static void UpdateAppointment()
{
    DBAppointment[] insertedAppointments = SchedulerExtension.GetAppointmentsToInsert<DBAppointment>("scheduler", SchedulerDataHelper.GetAppointments(),
        SchedulerDataHelper.GetResources(), SchedulerStorageProvider.DefaultAppointmentStorage, SchedulerStorageProvider.DefaultResourceStorage);
    foreach (var appt in insertedAppointments)
    {
        AppointmentDataAccessor.InsertAppointment(appt);
    }

    DBAppointment[] updatedAppointments = SchedulerExtension.GetAppointmentsToUpdate<DBAppointment>("scheduler", SchedulerDataHelper.GetAppointments(),
        SchedulerDataHelper.GetResources(), SchedulerStorageProvider.DefaultAppointmentStorage, SchedulerStorageProvider.DefaultResourceStorage);
    foreach (var appt in updatedAppointments)
    {
        AppointmentDataAccessor.UpdateAppointment(appt);
    }

    DBAppointment[] removedAppointments = SchedulerExtension.GetAppointmentsToRemove<DBAppointment>("scheduler", SchedulerDataHelper.GetAppointments(),
        SchedulerDataHelper.GetResources(), SchedulerStorageProvider.DefaultAppointmentStorage, SchedulerStorageProvider.DefaultResourceStorage);
    foreach (var appt in removedAppointments)
    {
        AppointmentDataAccessor.RemoveAppointment(appt);
    }
}

HomeController.vb

Public Function EditAppointment() As ActionResult
    UpdateAppointment()
    Return PartialView("SchedulerPartial", SchedulerDataHelper.DataObject)
End Function

Private Shared Sub UpdateAppointment()
    Dim insertedAppointments() As DBAppointment = SchedulerExtension.GetAppointmentsToInsert(Of DBAppointment)("scheduler", SchedulerDataHelper.GetAppointments(), SchedulerDataHelper.GetResources(), SchedulerStorageProvider.DefaultAppointmentStorage, SchedulerStorageProvider.DefaultResourceStorage)
    For Each appt In insertedAppointments
        AppointmentDataAccessor.InsertAppointment(appt)
    Next appt

    Dim updatedAppointments() As DBAppointment = SchedulerExtension.GetAppointmentsToUpdate(Of DBAppointment)("scheduler", SchedulerDataHelper.GetAppointments(), SchedulerDataHelper.GetResources(), SchedulerStorageProvider.DefaultAppointmentStorage, SchedulerStorageProvider.DefaultResourceStorage)
    For Each appt In updatedAppointments
        AppointmentDataAccessor.UpdateAppointment(appt)
    Next appt

    Dim removedAppointments() As DBAppointment = SchedulerExtension.GetAppointmentsToRemove(Of DBAppointment)("scheduler", SchedulerDataHelper.GetAppointments(), SchedulerDataHelper.GetResources(), SchedulerStorageProvider.DefaultAppointmentStorage, SchedulerStorageProvider.DefaultResourceStorage)
    For Each appt In removedAppointments
        AppointmentDataAccessor.RemoveAppointment(appt)
    Next appt
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetAppointmentsToRemove<T>(String, Object, Object, MVCxAppointmentStorage, MVCxResourceStorage) 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-custom-go-to-date-dialog/CS/Scheduler.CustomizationGotoDateForm/Controller/SchedulerController.cs#L46

void RemoveAppoinments() {
    Schedule[] schedules = SchedulerExtension.GetAppointmentsToRemove<Schedule>("scheduler", SchedulerHelper.DataObject.Appointments,
        SchedulerHelper.DataObject.Resources, SchedulerHelper.AppointmentStorage, SchedulerHelper.ResourceStorage);

asp-net-mvc-scheduler-crud-operations/CS/MVCSchedulerEditable/Controllers/HomeController.cs#L49

DBAppointment[] removedAppointments = SchedulerExtension.GetAppointmentsToRemove<DBAppointment>("scheduler", SchedulerDataHelper.GetAppointments(),
    SchedulerDataHelper.GetResources(), SchedulerStorageProvider.DefaultAppointmentStorage, SchedulerStorageProvider.DefaultResourceStorage);

asp-net-mvc-scheduler-custom-appointment-form/CS/Controllers/HomeController.cs#L69

CarScheduling[] removedAppt = SchedulerExtension.GetAppointmentsToRemove<CarScheduling>("scheduler", SchedulerDataHelper.GetAppointments(),
    SchedulerDataHelper.GetResources(), SchedulerDataHelper.DefaultAppointmentStorage, SchedulerDataHelper.DefaultResourceStorage);

VB.NET

asp-net-mvc-scheduler-crud-operations/VB/MVCSchedulerEditable/Controllers/HomeController.vb#L39

Dim removedAppointments As DBAppointment() = SchedulerExtension.GetAppointmentsToRemove(Of DBAppointment)("scheduler", SchedulerDataHelper.GetAppointments(), SchedulerDataHelper.GetResources(), SchedulerStorageProvider.DefaultAppointmentStorage, SchedulerStorageProvider.DefaultResourceStorage)
For Each appt In removedAppointments

asp-net-mvc-scheduler-custom-appointment-form/VB/Controllers/HomeController.vb#L58

Dim removedAppt As CarScheduling() = SchedulerExtension.GetAppointmentsToRemove(Of CarScheduling)("scheduler", SchedulerDataHelper.GetAppointments(), SchedulerDataHelper.GetResources(), SchedulerDataHelper.DefaultAppointmentStorage, SchedulerDataHelper.DefaultResourceStorage)
For Each appt In removedAppt