CustomJSPropertiesEventArgs.Properties Property

Gets a collection of temporary client properties.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

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

VB.NET

Public ReadOnly Property Properties As Dictionary(Of String, Object)

Property Value

Type	Description
Dictionary<String, Object>	The collection of property names and values.

Remarks

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.

Note

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

Example

Web Forms:

ASPX

<dx:ASPxGridView ID="grid" OnCustomJSProperties="GridView_CustomJSProperties" ...>
    ...
</dx:ASPxGridView>

C#

protected void GridView_CustomJSProperties(object sender, ASPxGridViewClientJSPropertiesEventArgs e) {
    e.Properties["cpVisibleRowCount"] = grid.VisibleRowCount;
    e.Properties["cpFilteredRowCountWithoutPage"] = GetFilteredRowCountWithoutPage();
}

JS

function GetSelectedFilteredRowCount() {
    return grid.cpFilteredRowCountWithoutPage + grid.GetSelectedKeysOnPage().length;
}

MVC:

C#

settings.CustomJSProperties = (s, e) => {
    var grid = s as MVCxGridView;
    e.Properties["cpVisibleRowCount"] = grid.VisibleRowCount;
    e.Properties["cpFilteredRowCountWithoutPage"] = GetFilteredRowCountWithoutPage(grid);
};

JS

function GetSelectedFilteredRowCount() {
  return grid.cpFilteredRowCountWithoutPage + grid.GetSelectedKeysOnPage().length;
}

Related GitHub Examples

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

Note

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.

C#

asp-net-web-forms-grid-cache-data-on-the-client-side/CS/Solution/Default.aspx.cs#L15

}
e.Properties["cpTitleId"] = titleId;
e.Properties["cpTitles"] = titles;

VB.NET

asp-net-web-forms-grid-cache-data-on-the-client-side/VB/Solution/Default.aspx.vb#L21

e.Properties("cpTitleId") = titleId
e.Properties("cpTitles") = titles