SchedulerSettings.CustomActionRouteValues Property

Defines the custom callback routing logic by specifying the names of a Controller and an Action which should handle custom callbacks initiated by the MVCxClientScheduler.PerformCallback client method.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v18.2.dll

Declaration

C#

public object CustomActionRouteValues { get; set; }

VB.NET

Public Property CustomActionRouteValues As Object

Property Value

Type	Description
Object	An object containing the Controller and Action names.

Remarks

Use the MVCxClientScheduler.PerformCallback client method if you need to asynchronously and dynamically update the Scheduler on the server (using AJAX-based callback technology) and performing server-side processing in the specified Action. Via the method’s data parameter, you can pass any information collected on the client to the server for further server processing.

The PerformCallback client method posts back to the server using the callback technology and is handled in an Action specified by the CustomActionRouteValues property. Any data passed via the method’s data parameter can be accessed on the server as a parameter of the specified Action. So, the required server-side actions can be performed in the handling Action based upon the value(s) passed from the client.

For instance, you can pass values as a hash table.

Client Script Code:

JS

myScheduler.PerformCallback({key1: value});

Controller Code:

C#

ActionResult MyAction(int key1){
    ...
}

The Scheduler automatically updates itself (it is re-rendered) after a custom callback has been sent and processed on the server.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomActionRouteValues property.

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#

how-to-bind-mvc-scheduler-to-a-collection-of-custom-objects-list-t153466/CS/DevExpressMvcApplication1/Models/SchedulerDataHelper.cs#L107

settings.EditAppointmentRouteValues = new { Controller = "Home", Action = "EditAppointment" };
settings.CustomActionRouteValues = new { Controller = "Home", Action = "CustomCallBackAction" };

how-to-customize-the-appointment-dialog-using-view-model-api-working-with-custom-fields-t582020/CS/DevExpressMvcApplication1/Models/SchedulerDataHelper.cs#L108

settings.EditAppointmentRouteValues = new { Controller = "Home", Action = "EditAppointment" };
settings.CustomActionRouteValues = new { Controller = "Home", Action = "CustomCallBackAction" };

VB.NET

how-to-bind-mvc-scheduler-to-a-collection-of-custom-objects-list-t153466/VB/DevExpressMvcApplication1/Models/SchedulerDataHelper.vb#L112

settings.EditAppointmentRouteValues = New With {Key .Controller = "Home", Key .Action = "EditAppointment"}
settings.CustomActionRouteValues = New With {Key .Controller = "Home", Key .Action = "CustomCallBackAction"}

how-to-create-a-custom-appointment-form-to-work-with-custom-fields-based-on-t153478-t156298/VB/DevExpressMvcApplication1/Models/SchedulerDataHelper.vb#L120

settings.EditAppointmentRouteValues = New With {Key .Controller = "Home", Key .Action = "EditAppointment"}
settings.CustomActionRouteValues = New With {Key .Controller = "Home", Key .Action = "CustomCallBackAction"}

how-to-customize-the-appointment-dialog-using-view-model-api-working-with-custom-fields-t582020/VB/DevExpressMvcApplication1/Models/SchedulerDataHelper.vb#L113

settings.EditAppointmentRouteValues = New With {Key .Controller = "Home", Key .Action = "EditAppointment"}
settings.CustomActionRouteValues = New With {Key .Controller = "Home", Key .Action = "CustomCallBackAction"}