Skip to main content

CustomJSPropertiesEventArgs.Properties Property

Gets a collection of temporary client properties.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v23.2.dll

NuGet Package: DevExpress.Web


public Dictionary<string, object> Properties { get; }

Property Value

Type Description
Dictionary<String, Object>

The collection of property names and values.


Run Demo: (Web Forms) ASPxGridView - Select All Rows Run Demo: (MVC) GridView - Select All Rows

Use the event parameter’s Properties property to add new properties that can be accessed on the client.


The only requirement is that property names must begin with the ‘cp’ prefix to avoid rewriting the object’s base properties.


Web Forms:

<dx:ASPxGridView ID="grid" OnCustomJSProperties="GridView_CustomJSProperties" ...>
protected void GridView_CustomJSProperties(object sender, ASPxGridViewClientJSPropertiesEventArgs e) {
    e.Properties["cpVisibleRowCount"] = grid.VisibleRowCount;
    e.Properties["cpFilteredRowCountWithoutPage"] = GetFilteredRowCountWithoutPage();
function GetSelectedFilteredRowCount() {
    return grid.cpFilteredRowCountWithoutPage + grid.GetSelectedKeysOnPage().length;


settings.CustomJSProperties = (s, e) => {
    var grid = s as MVCxGridView;
    e.Properties["cpVisibleRowCount"] = grid.VisibleRowCount;
    e.Properties["cpFilteredRowCountWithoutPage"] = GetFilteredRowCountWithoutPage(grid);
function GetSelectedFilteredRowCount() {
  return grid.cpFilteredRowCountWithoutPage + grid.GetSelectedKeysOnPage().length;

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Properties property.


The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also