ASPxGridBase.JSProperties Property

Enables you to supply any server with data that can then be parsed on the client.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

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

VB.NET

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

Property Value

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

Remarks

In some instances, it is necessary to obtain server information on the client. The JSProperties property enables you to declare temporary client properties. The JSProperties property represents a collection of property names and their values. Once declared, a property can be accessed on the client.

Note

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

Example

Web Forms approach:

C#

protected void grid_RowUpdated(object sender, DevExpress.Web.Data.ASPxDataUpdatedEventArgs e) {
    (sender as ASPxGridView).JSProperties["cpResult"] = returnValue;
}

MVC approach:

Razor(View)

settings.BeforeGetCallbackResult = (s, e) => {
    MVCxGridView grid = (MVCxGridView)s;
    if (grid.Selection.Count > 0)
        grid.JSProperties["cpSelectedRowKey"] = grid.GetSelectedFieldValues("Id")[0].ToString();
    else {
        grid.JSProperties["cpSelectedRowKey"] = false;
    }
};

JS

function InvoiceGrid_OnEndCallback(s, e) {
    if (s.cpSelectedRowKey)
        alert(s.cpSelectedRowKey);
}

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the JSProperties 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#

web-forms-pivot-grid-obtain-underlying-data/CS/ASPxPivotGrid_DisplayUnderlyingRecords/Default.aspx.cs#L21

    ASPxGridView1.PageIndex = 0;
    ASPxGridView1.JSProperties["cpShowDrillDownWindow"] = true;
}

VB.NET

web-forms-pivot-grid-obtain-underlying-data/VB/ASPxPivotGrid_DisplayUnderlyingRecords/Default.aspx.vb#L20

    ASPxGridView1.PageIndex = 0
    ASPxGridView1.JSProperties("cpShowDrillDownWindow") = True
End If