Skip to main content
Tab

ASPxGridViewClientJSPropertiesEventArgs Class

Provides data for the ASPxGridView.CustomJSProperties event.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.2.dll

NuGet Package: DevExpress.Web

#Declaration

public class ASPxGridViewClientJSPropertiesEventArgs :
    CustomJSPropertiesEventArgs

#Remarks

The ASPxGridView.CustomJSProperties event enables you to supply any server data via the temporary properties, that can be then 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 ASPxGridView base properties.

#Example

This example demonstrates how to obtain server data from the client. A temporary client property—cpPageIndex—is declared within the ASPxGridView.CustomJSProperties event handler. This property holds the index of the currently active page, and can be accessed on the client side.

protected void ASPxGridView1_CustomJSProperties(object sender,
   DevExpress.Web.ASPxGridViewClientJSPropertiesEventArgs e) {
    e.Properties["cpPageIndex"] = ASPxGridView1.PageIndex;
}

#Inheritance

Object
EventArgs
CustomJSPropertiesEventArgs
ASPxGridViewClientJSPropertiesEventArgs
See Also