CustomJSPropertiesEventArgs.Properties Property

Gets a collection of temporary client properties.

Assembly: DevExpress.Web.v18.2.dll

Declaration

C#
VB.NET

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

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

Property Value

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

Remarks

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

This example demonstrates how to cancel editing or disable the editor conditionally for the grid when batch editing is in use. It is possible to execute your logic either on the client or server side for a complex business model.

Then, handle the grid’s client-side ASPxClientGridView.BatchEditStartEditing event to either cancel the edit operation using the e.cancel property:


if (condition) e.cancel = true;

or disable the editor by obtaining its client instance:


var editor = s.GetEditor(e.focusedColumn.fieldName);
editor.SetEnabled(condition);

The custom server-side logic can be executed in the CustomJSProperties event handler:


protected void ASPxGridView1_CustomJSProperties(object sender, DevExpress.Web.ASPxGridView.ASPxGridViewClientJSPropertiesEventArgs e) {
    var clientData = new Dictionary<int, object>();
    var grid = sender as ASPxGridView;
    for (int i = 0; i < grid.VisibleRowCount; i++) {
        var rowValues = grid.GetRowValues(i, new string[] { "ID", "ServerSideExample" }) as object[];

        var key = Convert.ToInt32(rowValues[0]);
        if (key % 2 != 0)
            clientData.Add(key, "ServerSideExample");
    }
    e.Properties["cp_cellsToDisable"] = clientData;
}

Note

A complete sample project is available at https://github.com/DevExpress-Examples/aspxgridview-batch-editing-how-to-cancel-editing-or-disable-the-editor-conditionally-t115144

<%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>

<%@ Register Assembly="DevExpress.Web.v14.1, Version=14.1.13.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" Namespace="DevExpress.Web.ASPxGridView" TagPrefix="dx" %>

<%@ Register assembly="DevExpress.Web.v14.1, Version=14.1.13.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" namespace="DevExpress.Web.ASPxEditors" tagprefix="dx" %>

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
    <script type="text/javascript">
        function OnBatchStartEdit(s, e) {
            //client processing
            var keyIndex = s.GetColumnByField("ID").index;
            var key = e.rowValues[keyIndex].value;

            var condition = key % 2 == 0;

            if (e.focusedColumn.fieldName == "ClientSideCancel") //cancel example
                if (!condition) e.cancel = true;

            //server preprocessing
            if (typeof s.cp_cellsToDisable[key] != "undefined" && s.cp_cellsToDisable[key] == e.focusedColumn.fieldName)
                e.cancel = true;
        }
    </script>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <dx:ASPxGridView ID="ASPxGridView1" runat="server" KeyFieldName="ID" OnCustomJSProperties="ASPxGridView1_CustomJSProperties">
            <SettingsEditing Mode="Batch"></SettingsEditing>
            <ClientSideEvents BatchEditStartEditing="OnBatchStartEdit" />
        </dx:ASPxGridView>
    </div>
    </form>
</body>
</html>

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using DevExpress.Web.ASPxGridView;

public partial class _Default : System.Web.UI.Page {
    protected void Page_Load(object sender, EventArgs e) {
        ASPxGridView1.DataSource = Enumerable.Range(0, 10).Select(i => new {
            ID = i,
            ClientSideCancel = "Example " + i,
            SampleColumn = "Sample data " + i,
            ServerSideExample = i * 123
        });
        ASPxGridView1.DataBind();
    }
    protected void ASPxGridView1_CustomJSProperties(object sender, DevExpress.Web.ASPxGridView.ASPxGridViewClientJSPropertiesEventArgs e) {
        var clientData = new Dictionary<int, object>();
        var grid = sender as ASPxGridView;
        for (int i = grid.VisibleStartIndex; i < grid.VisibleStartIndex + grid.SettingsPager.PageSize; i++) {
            var rowValues = grid.GetRowValues(i, new string[] { "ID", "ServerSideExample" }) as object[];

            var key = Convert.ToInt32(rowValues[0]);
            if (key % 2 != 0)
                clientData.Add(key, "ServerSideExample");
        }
        e.Properties["cp_cellsToDisable"] = clientData;
    }
}

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports DevExpress.Web.ASPxGridView

Partial Public Class _Default
    Inherits System.Web.UI.Page
    Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
        ASPxGridView1.DataSource = Enumerable.Range(0, 10).Select(Function(i) New With {Key .ID = i, Key .ClientSideCancel = "Example " & i, Key .SampleColumn = "Sample data " & i, Key .ServerSideExample = i * 123})
        ASPxGridView1.DataBind()
    End Sub
    Protected Sub ASPxGridView1_CustomJSProperties(ByVal sender As Object, ByVal e As DevExpress.Web.ASPxGridView.ASPxGridViewClientJSPropertiesEventArgs)
        Dim clientData = New Dictionary(Of Integer, Object)()
        Dim grid = TryCast(sender, ASPxGridView)
        For i As Integer = grid.VisibleStartIndex To grid.VisibleStartIndex + grid.SettingsPager.PageSize
            Dim rowValues = TryCast(grid.GetRowValues(i, New String() { "ID", "ServerSideExample" }), Object())

            Dim key = Convert.ToInt32(rowValues(0))
            If key Mod 2 <> 0 Then
                clientData.Add(key, "ServerSideExample")
            End If
        Next i
        e.Properties("cp_cellsToDisable") = clientData
    End Sub
End Class

<%@ Page Language="vb" AutoEventWireup="true" CodeFile="Default.aspx.vb" Inherits="_Default" %>

<%@ Register Assembly="DevExpress.Web.v14.1, Version=14.1.3.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" Namespace="DevExpress.Web.ASPxGridView" TagPrefix="dx" %>

<%@ Register assembly="DevExpress.Web.v14.1, Version=14.1.3.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a" namespace="DevExpress.Web.ASPxEditors" tagprefix="dx" %>

<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
    <script type="text/javascript">
        function OnBatchStartEdit(s, e) {
            //client processing
            var keyIndex = s.GetColumnByField("ID").index;
            var key = e.rowValues[keyIndex].value;

            var condition = key % 2 == 0;

            if (e.focusedColumn.fieldName == "ClientSideCancel") //cancel example
                if (!condition) e.cancel = true;

            //server preprocessing
            if (typeof s.cp_cellsToDisable[key] != "undefined" && s.cp_cellsToDisable[key] == e.focusedColumn.fieldName)
                e.cancel = true;
        }
    </script>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <dx:ASPxGridView ID="ASPxGridView1" runat="server" KeyFieldName="ID" OnCustomJSProperties="ASPxGridView1_CustomJSProperties">
            <SettingsEditing Mode="Batch"></SettingsEditing>
            <ClientSideEvents BatchEditStartEditing="OnBatchStartEdit" />
        </dx:ASPxGridView>
    </div>
    </form>
</body>
</html>

The following code snippets (auto-collected from DevExpress Examples) contain references 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#
VB.NET

how-to-implement-the-select-all-check-box-functionality-in-aspxcardview-t446605/CS/DxExample/WebForm1.aspx.cs#L20

    ASPxCardView cv = sender as ASPxCardView;
    e.Properties["cpVisibleCardCount"] = cv.VisibleCardCount;
}

aspxtreelist-how-to-implement-node-reordering-t604737/CS/NodeReordering/Default.aspx.cs#L53

    ASPxTreeList tree = (ASPxTreeList)sender;
    e.Properties["cpSiblingKeys"] = tree.GetAllNodes().ToDictionary(n => n.Key, n => n.ParentNode.ChildNodes.OfType<TreeListNode>().Select(c => c.Key));
}

how-to-implement-the-select-all-check-box-functionality-in-aspxcardview-t446605/VB/DxExample/WebForm1.aspx.vb#L22

    Dim cv As ASPxCardView = TryCast(sender, ASPxCardView)
    e.Properties("cpVisibleCardCount") = cv.VisibleCardCount
End Sub

aspxtreelist-how-to-implement-node-reordering-t604737/VB/NodeReordering/Default.aspx.vb#L40

    Dim tree As ASPxTreeList = DirectCast(sender, ASPxTreeList)
    e.Properties("cpSiblingKeys") = tree.GetAllNodes().ToDictionary(Function(n) n.Key, Function(n) n.ParentNode.ChildNodes.OfType(Of TreeListNode)().Select(Function(c) c.Key))
End Sub

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

CustomJSPropertiesEventArgs.Properties Property

Declaration

Property Value

Remarks

Example

CustomJSPropertiesEventArgs.Properties Property

Declaration

Property Value

Remarks

Example

Related GitHub Examples