Skip to main content

GridViewSettings.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


public ASPxGridViewClientJSPropertiesEventHandler CustomJSProperties { get; set; }

Property Value

Type Description

A ASPxGridViewClientJSPropertiesEventHandler delegate method allowing you to implement custom processing.


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 GridView extension.


How to Access Server Data on the Client Side

Online Demo

GridView - Select All Rows


Html.DevExpress().GridView(settings => {
    settings.Name = "grid";
    settings.CallbackRouteValues = new { Action = "AdvancedSelectionPartial", Controller = "Selection" };
    settings.CustomJSProperties = (s, e) => {
        var grid = s as MVCxGridView;
        e.Properties["cpVisibleRowCount"] = grid.VisibleRowCount;
        e.Properties["cpFilteredRowCountWithoutPage"] = GetFilteredRowCountWithoutPage(grid);

Online Examples

See Also