Skip to main content

TreeListCustomJSPropertiesEventArgs Class

Provides data for the ASPxTreeList.CustomJSProperties event.

Namespace: DevExpress.Web.ASPxTreeList

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

NuGet Package: DevExpress.Web

Declaration

public class TreeListCustomJSPropertiesEventArgs :
    CustomJSPropertiesEventArgs

Remarks

The ASPxTreeList.CustomJSProperties event enables you to supply any server data via the temporary properties, that can then be accessed on the client. The CustomJSPropertiesEventArgs.Properties property represents a collection of property names and values. Note that property names must begin with the ‘cp’ prefix to avoid rewriting the ASPxTreeList base properties.

Example

protected void ASPxTreeList1_CustomJSProperties(object sender,
TreeListCustomJSPropertiesEventArgs e) {
    // Scalar value
    e.Properties["cpScalar"] = "my value";

    // Nested arrays
    e.Properties["cpNestedArrays"] = new object[] { 
        "value",
        null,
        new string[] { "name1", "name2" }};

    // Hashtable
    Hashtable hash = new Hashtable();
    hash.Add("key", "value");
    e.Properties["cpHash"] = hash;
}

Inheritance

Object
EventArgs
CustomJSPropertiesEventArgs
TreeListCustomJSPropertiesEventArgs
See Also