Grid View for ASP.NET Web Forms - How to bind a Combo Box column to data based on the row index in batch edit mode

This example demonstrates how to populate a GridViewDataComboBoxColumn's cell editors at runtime in batch edit mode.

Bind Combo Box Column in Batch Edit Mode

Implementation Details

In batch edit mode, the Grid View does not send requests to the server when a cell editor is activated. Therefore, it is not possible to use the CellEditorInitialize event handler on the server to populate a combo box in each row.

To overcome this limitation, use the combo box editor's callback to populate the editor with items.

Handle the grid's CellEditorInitialize event. In the event handler, assign a new handler to the combo box cell editor's Callback event:

C#
protected void Grid_CellEditorInitialize(object sender, ASPxGridViewEditorEventArgs e) {  
    if (e.Column.FieldName == "C3") {  
        ASPxComboBox combo = e.Editor as ASPxComboBox;  
        combo.Callback += combo_Callback;  
    }  
}

Call the combo box editor's PerformCallback method from the client ASPxClientGridView.BatchEditStartEditing event handler. Pass the current row's visible index as the callback parameter:

ASPx
<dx:ASPxGridView ID="Grid" runat="server" KeyFieldName="ID" ... >  
    ...  
    <ClientSideEvents BatchEditStartEditing="OnBatchEditStartEditing" />  
</dx:ASPxGridView>

Code
function OnBatchEditStartEditing(s, e) {  
    cmb.PerformCallback();  
}

Add items to the combo box in the Callback event handler. You can get the current row index from e.Parameter.

C#
void combo_Callback(object sender, DevExpress.Web.CallbackEventArgsBase e) {  
    ASPxComboBox combo = sender as ASPxComboBox;  
    for (int i = 0; i < 10; i++) {  
        combo.Items.Add(string.Format("Row_{0} Item_{1}", e.Parameter, i), i);  
    }  
}

Documentation

More Examples

Example Code

Default.aspx

ASPx
<%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="_Default" %>
<%@ Register Assembly="DevExpress.Web.v23.1, Version=23.1.4.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a"
    Namespace="DevExpress.Web" TagPrefix="dx" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
    <title></title>
    <script type="text/javascript">
        function OnBatchEditStartEditing(s, e) {
            cmb.PerformCallback();
        }

        function OnEndCallback(s, e) {
            s.SetValue(s.GetValue());
        }
</script>
</head>
<body>
    <form id="frmMain" runat="server">
    <dx:ASPxCheckBox ID="BatchUpdateCheckBox" runat="server" Text="Handle BatchUpdate event"
        AutoPostBack="true" />
    <dx:ASPxGridView ID="Grid" runat="server" KeyFieldName="ID" OnBatchUpdate="Grid_BatchUpdate"
        OnRowInserting="Grid_RowInserting" OnRowUpdating="Grid_RowUpdating" OnRowDeleting="Grid_RowDeleting" OnCellEditorInitialize="Grid_CellEditorInitialize">
        <Columns>
            <dx:GridViewCommandColumn ShowNewButtonInHeader="true" ShowDeleteButton="true" />
            <dx:GridViewDataColumn FieldName="C1" />
            <dx:GridViewDataSpinEditColumn FieldName="C2" />
            <dx:GridViewDataComboBoxColumn FieldName="C3" >
                <PropertiesComboBox ClientInstanceName="cmb">
                    <ClientSideEvents EndCallback="OnEndCallback" />
                </PropertiesComboBox>
            </dx:GridViewDataComboBoxColumn>
            <dx:GridViewDataCheckColumn FieldName="C4" />
        </Columns>
        <ClientSideEvents BatchEditStartEditing="OnBatchEditStartEditing" />
        <SettingsEditing Mode="Batch" />
    </dx:ASPxGridView>
    </form>
</body>
</html>

Default.aspx.cs(vb)

C#
VB.NET

C#
using System;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.ComponentModel;
using System.Linq;
using DevExpress.Web.Data;
using DevExpress.Web;

public partial class _Default : System.Web.UI.Page {
    protected List<GridDataItem> GridData {
        get {
            var key = "34FAA431-CF79-4869-9488-93F6AAE81263";
            if(!IsPostBack || Session[key] == null)
                Session[key] = Enumerable.Range(0, 100).Select(i => new GridDataItem {
                    ID = i,
                    C1 = i % 2,
                    C2 = i * 0.5 % 3,
                    C3 = "C3 " + i,
                    C4 = i % 2 == 0
                }).ToList();
            return (List<GridDataItem>)Session[key];
        }
    }
    protected void Page_Load(object sender, EventArgs e) {
        Grid.DataSource = GridData;
        Grid.DataBind();
    }
    protected void Grid_RowInserting(object sender, ASPxDataInsertingEventArgs e) {
        InsertNewItem(e.NewValues);
        CancelEditing(e);
    }
    protected void Grid_RowUpdating(object sender, ASPxDataUpdatingEventArgs e) {
        UpdateItem(e.Keys, e.NewValues);
        CancelEditing(e);
    }
    protected void Grid_RowDeleting(object sender, ASPxDataDeletingEventArgs e) {
        DeleteItem(e.Keys, e.Values);
        CancelEditing(e);
    }
    protected void Grid_BatchUpdate(object sender, ASPxDataBatchUpdateEventArgs e) {
        if(!BatchUpdateCheckBox.Checked)
            return;

        foreach(var args in e.InsertValues)
            InsertNewItem(args.NewValues);
        foreach(var args in e.UpdateValues)
            UpdateItem(args.Keys, args.NewValues);
        foreach(var args in e.DeleteValues)
            DeleteItem(args.Keys, args.Values);

        e.Handled = true;
    }
    protected GridDataItem InsertNewItem(OrderedDictionary newValues) {
        var item = new GridDataItem() { ID = GridData.Count };
        LoadNewValues(item, newValues);
        GridData.Add(item);
        return item;
    }
    protected GridDataItem UpdateItem(OrderedDictionary keys, OrderedDictionary newValues) {
        var id = Convert.ToInt32(keys["ID"]);
        var item = GridData.First(i => i.ID == id);
        LoadNewValues(item, newValues);
        return item;
    }
    protected GridDataItem DeleteItem(OrderedDictionary keys, OrderedDictionary values) {
        var id = Convert.ToInt32(keys["ID"]);
        var item = GridData.First(i => i.ID == id);
        GridData.Remove(item);
        return item;
    }
    protected void LoadNewValues(GridDataItem item, OrderedDictionary values) {
        item.C1 = Convert.ToInt32(values["C1"]);
        item.C2 = Convert.ToDouble(values["C2"]);
        item.C3 = Convert.ToString(values["C3"]);
        item.C4 = Convert.ToBoolean(values["C4"]);
    }
    protected void CancelEditing(CancelEventArgs e) {
        e.Cancel = true;
        Grid.CancelEdit();
    }
    public class GridDataItem {
        public int ID { get; set; }
        public int C1 { get; set; }
        public double C2 { get; set; }
        public string C3 { get; set; }
        public bool C4 { get; set; }
    }
    protected void Grid_CellEditorInitialize(object sender, ASPxGridViewEditorEventArgs e) {
        if (e.Column.FieldName == "C3") {
            ASPxComboBox combo = e.Editor as ASPxComboBox;
            combo.Callback += combo_Callback;
        }
    }

    void combo_Callback(object sender, DevExpress.Web.CallbackEventArgsBase e) {
        ASPxComboBox combo = sender as ASPxComboBox;
        for (int i = 0; i < 10; i++)
        {
            combo.Items.Add(string.Format("Row_{0} Item_{1}", e.Parameter, i), i);
        }
    }
}

Visual Basic
Imports Microsoft.VisualBasic
Imports System
Imports System.Collections.Generic
Imports System.Collections.Specialized
Imports System.ComponentModel
Imports System.Linq
Imports DevExpress.Web.Data
Imports DevExpress.Web

Partial Public Class _Default
    Inherits System.Web.UI.Page
    Protected ReadOnly Property GridData() As List(Of GridDataItem)
        Get
            Dim key = "34FAA431-CF79-4869-9488-93F6AAE81263"
            If (Not IsPostBack) OrElse Session(key) Is Nothing Then
                Session(key) = Enumerable.Range(0, 100).Select(Function(i) New GridDataItem With {.ID = i, .C1 = i Mod 2, .C2 = i * 0.5 Mod 3, .C3 = "C3 " & i, .C4 = i Mod 2 = 0}).ToList()
            End If
            Return CType(Session(key), List(Of GridDataItem))
        End Get
    End Property
    Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
        Grid.DataSource = GridData
        Grid.DataBind()
    End Sub
    Protected Sub Grid_RowInserting(ByVal sender As Object, ByVal e As ASPxDataInsertingEventArgs)
        InsertNewItem(e.NewValues)
        CancelEditing(e)
    End Sub
    Protected Sub Grid_RowUpdating(ByVal sender As Object, ByVal e As ASPxDataUpdatingEventArgs)
        UpdateItem(e.Keys, e.NewValues)
        CancelEditing(e)
    End Sub
    Protected Sub Grid_RowDeleting(ByVal sender As Object, ByVal e As ASPxDataDeletingEventArgs)
        DeleteItem(e.Keys, e.Values)
        CancelEditing(e)
    End Sub
    Protected Sub Grid_BatchUpdate(ByVal sender As Object, ByVal e As ASPxDataBatchUpdateEventArgs)
        If (Not BatchUpdateCheckBox.Checked) Then
            Return
        End If

        For Each args In e.InsertValues
            InsertNewItem(args.NewValues)
        Next args
        For Each args In e.UpdateValues
            UpdateItem(args.Keys, args.NewValues)
        Next args
        For Each args In e.DeleteValues
            DeleteItem(args.Keys, args.Values)
        Next args

        e.Handled = True
    End Sub
    Protected Function InsertNewItem(ByVal newValues As OrderedDictionary) As GridDataItem
        Dim item = New GridDataItem() With {.ID = GridData.Count}
        LoadNewValues(item, newValues)
        GridData.Add(item)
        Return item
    End Function
    Protected Function UpdateItem(ByVal keys As OrderedDictionary, ByVal newValues As OrderedDictionary) As GridDataItem
        Dim id = Convert.ToInt32(keys("ID"))
        Dim item = GridData.First(Function(i) i.ID = id)
        LoadNewValues(item, newValues)
        Return item
    End Function
    Protected Function DeleteItem(ByVal keys As OrderedDictionary, ByVal values As OrderedDictionary) As GridDataItem
        Dim id = Convert.ToInt32(keys("ID"))
        Dim item = GridData.First(Function(i) i.ID = id)
        GridData.Remove(item)
        Return item
    End Function
    Protected Sub LoadNewValues(ByVal item As GridDataItem, ByVal values As OrderedDictionary)
        item.C1 = Convert.ToInt32(values("C1"))
        item.C2 = Convert.ToDouble(values("C2"))
        item.C3 = Convert.ToString(values("C3"))
        item.C4 = Convert.ToBoolean(values("C4"))
    End Sub
    Protected Sub CancelEditing(ByVal e As CancelEventArgs)
        e.Cancel = True
        Grid.CancelEdit()
    End Sub
    Public Class GridDataItem
        Private privateID As Integer
        Public Property ID() As Integer
            Get
                Return privateID
            End Get
            Set(ByVal value As Integer)
                privateID = value
            End Set
        End Property
        Private privateC1 As Integer
        Public Property C1() As Integer
            Get
                Return privateC1
            End Get
            Set(ByVal value As Integer)
                privateC1 = value
            End Set
        End Property
        Private privateC2 As Double
        Public Property C2() As Double
            Get
                Return privateC2
            End Get
            Set(ByVal value As Double)
                privateC2 = value
            End Set
        End Property
        Private privateC3 As String
        Public Property C3() As String
            Get
                Return privateC3
            End Get
            Set(ByVal value As String)
                privateC3 = value
            End Set
        End Property
        Private privateC4 As Boolean
        Public Property C4() As Boolean
            Get
                Return privateC4
            End Get
            Set(ByVal value As Boolean)
                privateC4 = value
            End Set
        End Property
    End Class
    Protected Sub Grid_CellEditorInitialize(ByVal sender As Object, ByVal e As ASPxGridViewEditorEventArgs)
        If e.Column.FieldName = "C3" Then
            Dim combo As ASPxComboBox = TryCast(e.Editor, ASPxComboBox)
            AddHandler combo.Callback, AddressOf combo_Callback
        End If
    End Sub

    Private Sub combo_Callback(ByVal sender As Object, ByVal e As DevExpress.Web.CallbackEventArgsBase)
        Dim combo As ASPxComboBox = TryCast(sender, ASPxComboBox)
        For i As Integer = 0 To 9
            combo.Items.Add(String.Format("Row_{0} Item_{1}", e.Parameter, i), i)
        Next i
    End Sub
End Class

Lanette (DevExpress Support)

last modified 7 years ago

Modified: February 16, 2018 12:23 PM

Platform: ASP.NET Web Forms

Product: ASPxGridView

Disclaimer: The information provided on DevExpress.com and affiliated web properties (including the DevExpress Support Center) is provided "as is" without warranty of any kind. Developer Express Inc disclaims all warranties, either express or implied, including the warranties of merchantability and fitness for a particular purpose. Please refer to the DevExpress.com Website Terms of Use for more information in this regard.

Confidential Information: Developer Express Inc does not wish to receive, will not act to procure, nor will it solicit, confidential or proprietary materials and information from you through the DevExpress Support Center or its web properties. Any and all materials or information divulged during chats, email communications, online discussions, Support Center tickets, or made available to Developer Express Inc in any manner will be deemed NOT to be confidential by Developer Express Inc. Please refer to the DevExpress.com Website Terms of Use for more information in this regard.