TreeListSettings.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 MVCxClientTreeList.PerformCallback method.

Namespace: DevExpress.Web.Mvc

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

NuGet Package: DevExpress.Web.Mvc5

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 client MVCxClientTreeList.PerformCallback method if you need to dynamically update the TreeList by asynchronously going to 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 client PerformCallback 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 necessary 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

myTreeList.PerformCallback({key1: value});

Controller Code:

C#

ActionResult MyAction(int key1){
    ...
}

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

If you need to perform a custom callback to the server without updating the TreeList, you can send it via the client MVCxClientTreeList.PerformCustomDataCallback method and handle it in an Action specified via the TreeListSettings.CustomDataActionRouteValues property.