TreeListSettings.CustomJSProperties Property

Enables you to supply any server data that can then be parsed on the client.

Namespace: DevExpress.Web.Mvc

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

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public TreeListCustomJSPropertiesEventHandler CustomJSProperties { get; set; }

VB.NET

Public Property CustomJSProperties As TreeListCustomJSPropertiesEventHandler

Property Value

Type	Description
TreeListCustomJSPropertiesEventHandler	A TreeListCustomJSPropertiesEventHandler delegate method allowing you to implement custom processing.

Remarks

In some instances, it is necessary to obtain server information on the client. The delegate method defined by the CustomJSProperties property enables you to declare temporary client properties. Once declared, a property can be accessed on the client.

To add new properties, use the parameter’s CustomJSPropertiesEventArgs.Properties property, which represents a collection of property names and their values. The only requirement is that property names must begin with the ‘cp’ prefix, to avoid rewriting the base properties exposed by the TreeListSettings.

C#

settings.CustomJSProperties = (sender, e) => {
    e.Properties["cpParam1"] = "my value";
};
...
settings.DataBound = (sender, e) => {
    MVCxTreeList list = sender as MVCxTreeList;
    list.JSProperties["cp_Param2"] = "my value";
};

Concept

How to Access Server Data on the Client Side