TreeListSettings.CustomDataActionRouteValues Property

Defines the custom callback routing logic by specifying the names of a Controller and an Action which should handle custom data callbacks initiated by the MVCxClientTreeList.PerformCustomDataCallback method.

Namespace: DevExpress.Web.Mvc

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

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public object CustomDataActionRouteValues { get; set; }

VB.NET

Public Property CustomDataActionRouteValues As Object

Property Value

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

Remarks

Use the client MVCxClientTreeList.PerformCustomDataCallback method if you need to asynchronously go to the server (using AJAX-based callback technology) and perform server-side processing in the specified Action without updating (re-rendering) the TreeList after that. Via the CustomDataActionRouteValues method’s data parameter, you can pass any information collected on the client to the server, for further server processing.

The client PerformCustomDataCallback method posts back to the server using the callback technology and is handled in an Action specified by the CustomDataActionRouteValues 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.PerformCustomDataCallback({key1: value});

Controller Code:

C#

ActionResult MyAction(int key1){
    ...
}

The TreeList does not automatically update (re-render) itself after such a custom data callback has been sent and processed on the server.

If you need to perform a custom callback to the server that updates the TreeList, you can send this callback via the client MVCxClientTreeList.PerformCallback method and handle it in an Action specified via the TreeListSettings.CustomActionRouteValues property.