GridViewSettings.CustomJSProperties Property

Namespace: DevExpress.Web.Mvc

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

Declaration

public ASPxGridViewClientJSPropertiesEventHandler CustomJSProperties { get; set; }

Public Property CustomJSProperties As ASPxGridViewClientJSPropertiesEventHandler

Property Value

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

Concept

How to Access Server Data on the Client Side

Online Demo

GridView - Select All Rows

Example

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);
    };
}).Bind(Model).GetHtml()

Online Examples

• GridView - How to show a message after CRUD operations

• GridView - Access/modify FilterExpression on the controller and save/load custom filters

• GridView - How to create a custom tooltip for cells to display long text

• GridView - How to track ClientLayout with a separate ListBox

• GridView - How to implement data editing with hidden column