GridView.CustomRowCellEdit Event

Allows you to assign custom in-place editors to individual cells. To avoid performance issues and increased memory consumption, assign repository items that already exist in the GridControl.RepositoryItems collection. Do not create new repository items in this handler.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v22.2.dll

NuGet Package: DevExpress.Win.Grid

Declaration

C#

[DXCategory("Editor")]
public event CustomRowCellEditEventHandler CustomRowCellEdit

VB.NET

<DXCategory("Editor")>
Public Event CustomRowCellEdit As CustomRowCellEditEventHandler

Event Data

The CustomRowCellEdit event's data class is CustomRowCellEditEventArgs. The following properties provide information specific to this event:

Property	Description
CellValue	Returns the currently processed cell value. Inherited from CustomRowCellEventArgs.
Column	Gets the column to which the currently processed cell corresponds. Inherited from CustomRowCellEventArgs.
RepositoryItem	Gets or sets the editor used to edit the currently processed cell.
RowHandle	Gets the handle of the row that contains the processed cell. Inherited from CustomRowCellEventArgs.

Remarks

To use the same data editor for all cells in a column, assign the required editor to the GridColumn.ColumnEdit property.

C#

var textEdit = new RepositoryItemTextEdit();
gridControl1.RepositoryItems.Add(textEdit);
gc.ColumnEdit = textEdit;

VB.NET

Dim textEdit = New RepositoryItemTextEdit()
gridControl1.RepositoryItems.Add(textEdit)
gc.ColumnEdit = textEdit

If you need a different in-place editor for an individual cell, handle the CustomRowCellEdit event and assign the required RepositoryItem descendant to the CustomRowCellEditEventArgs.RepositoryItem property.

Example

The following code from the Assign in-place editors dynamically Demo Center module assigns either a SpinEdit or a CalcEdit editor to cells under the “Length” column. The actual editor type depends on whether a check box in the “Mark” column is checked.

C#

RepositoryItemSpinEdit spinEdit = new RepositoryItemSpinEdit();
RepositoryItemCalcEdit calcEdit = new RepositoryItemCalcEdit();
gridControl1.RepositoryItems.AddRange(new RepositoryItem[] { spinEdit, calcEdit });
gridView.Columns["Length"].ShowButtonMode = ShowButtonModeEnum.ShowAlways;

// Handle this event to assign editors to individual cells
gridView.CustomRowCellEdit += (sender, e) => {
    GridView view = sender as GridView;
    if (e.Column.FieldName == "Length") {
        bool boolVal = (bool)view.GetRowCellValue(e.RowHandle, "Mark");
        if (boolVal)
            e.RepositoryItem = spinEdit;
     else
            e.RepositoryItem = calcEdit;
    }
};

VB.NET

Dim spinEdit As New RepositoryItemSpinEdit()
Dim calcEdit As New RepositoryItemCalcEdit()
gridControl1.RepositoryItems.AddRange(New RepositoryItem() { spinEdit, calcEdit })
gridView.Columns("Length").ShowButtonMode = ShowButtonModeEnum.ShowAlways

' Handle this event to assign editors to individual cells
AddHandler gridView.CustomRowCellEdit, Sub(sender, e)
    Dim view As GridView = TryCast(sender, GridView)
    If e.Column.FieldName = "Length" Then
        Dim boolVal As Boolean = CBool(view.GetRowCellValue(e.RowHandle, "Mark"))
        If boolVal Then
            e.RepositoryItem = spinEdit
     Else
            e.RepositoryItem = calcEdit
     End If
    End If
End Sub

Use Separate Data Editors to Display and Edit Values

The custom editor you specify on the CustomRowCellEdit event will be used to both display and edit cell data. Handle the GridView.CustomRowCellEditForEditing event to use two separate editors for these tasks.

The code below illustrates how to assign a ProgressBarControl editor to the “Length” column cells. Since a Progress Bar Control has no built-in means to edit data, users will be unable to change these cell values. To fix this issue, the GridView.CustomRowCellEditForEditing event replaces the Progress Bar Control with a Spin Edit when a user focuses a cell.

C#

RepositoryItemProgressBar progress= new RepositoryItemProgressBar();
RepositoryItemSpinEdit spin = new RepositoryItemSpinEdit();
gridControl1.RepositoryItems.AddRange(new RepositoryItem[] { spin, progress });
// Custom editor that displays cell values
colLength.ColumnEdit = progress;

// Custom editor that edits cell values
gridView.CustomRowCellEditForEditing += (sender, e) => {
    GridView view = sender as GridView;
    if (e.Column.FieldName == "Length") 
        e.RepositoryItem = spin;
};

VB.NET

Dim progress As New RepositoryItemProgressBar()
Dim spin As New RepositoryItemSpinEdit()
gridControl1.RepositoryItems.AddRange(New RepositoryItem() { spin, progress })
' Custom editor that displays cell values
colLength.ColumnEdit = progress

' Custom editor that edits cell values
AddHandler gridView.CustomRowCellEditForEditing, Sub(sender, e)
    Dim view As GridView = TryCast(sender, GridView)
    If e.Column.FieldName = "Length" Then
        e.RepositoryItem = spin
    End If
End Sub

Editors you assign on the GridView.CustomRowCellEditForEditing event are also used within Edit Forms.

Special notes

• If you check whether or not a Grid row is focused before you assign a custom editor to a cell, this cell may use your custom editor only to display data. In the animation below, when a user clicks “Length” cells to edit their values, the cell invokes default Text Edit editors. Custom Spin Edit editors appear only when a user first selects another cell, then moves focus to a “Length” cell.

  

  C#

    gridView.CustomRowCellEdit += (sender, e) => {
        GridView view = sender as GridView;
        if (e.Column.FieldName == "Length" && e.RowHandle == gridView.FocusedRowHandle) 
            e.RepositoryItem = spinEdit;
    };
  

  VB.NET

      AddHandler gridView.CustomRowCellEdit, Sub(sender, e)
        Dim view As GridView = TryCast(sender, GridView)
        If e.Column.FieldName = "Length" AndAlso e.RowHandle = gridView.FocusedRowHandle Then
            e.RepositoryItem = spinEdit
        End If
    End Sub
  

  To avoid such issues, handle the GridView.CustomRowCellEditForEditing event in addition to the CustomRowCellEdit event.

• The CustomRowCellEdit event fires whenever a cell is updated. For that reason, this event fires relatively frequently. Do not update the Grid’s visual elements or implement complex logic for your CustomRowCellEdit event handler as it can severely impact application performance.

• The CustomRowCellEdit event is designed solely for the described scenario: to provide ready-to-use editors to individual data cells. Do not modify properties of any existing Repository Items (including “e.RepositoryItem” objects) in this event. Create and\or customize required editors beforehand.