ColumnView.SetRowCellValue(Int32, String, Object) Method

Sets the value of the specified cell in the current View.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v23.2.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

public void SetRowCellValue(
    int rowHandle,
    string fieldName,
    object _value
)

VB.NET

Public Sub SetRowCellValue(
    rowHandle As Integer,
    fieldName As String,
    _value As Object
)

Parameters

Name	Type	Description
rowHandle	Int32	An integer value representing the handle of the row which contains the desired cell.
fieldName	String	A string representing the field name that identifies the required cell.
_value	Object	An object representing the value to be assigned.

Remarks

This method does nothing in the following cases:

• the specified row handle is invalid or points to a group row;
• the current View doesn’t contain a column bound to the specified field name;
• the View’s ColumnView.Columns collection does not contain a GridColumn bound to the specified fieldName.
• the specified row is a non-initialized New Item Row.

To get a cell’s value, the ColumnView.GetRowCellValue method can be used.

Changing a cell value raises the ColumnView.CellValueChanged event.

For more information on row handles, refer to the Rows document.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the SetRowCellValue member must not be invoked for these Views. The SetRowCellValue member can only be used with Views that display real data within the Grid Control. Use the following methods to access these Views with which an end user interacts at runtime.

• GridControl.MainView - returns the top most View in a grid;
• GridControl.FocusedView - returns the focused View;
• GridControl.DefaultView - returns the currently maximized View;
• the sender parameter of View specific events;
• GridView.GetDetailView - returns a detail clone View for a specific master row.

Example

The code sample below iterates through grid records and reduces the “Price” column values by 10 percent.

C#

private void UpdatePrice(DevExpress.XtraGrid.Views.Base.ColumnView View) {
   // Obtain the Price column. 
   DevExpress.XtraGrid.Columns.GridColumn col = View.Columns.ColumnByFieldName("Price");
   if (col == null) return;
   View.BeginSort();
   try {
      // Obtain the number of data rows. 
      int dataRowCount = View.DataRowCount;
      // Traverse data rows and change the Price field values. 
      for (int i = 0; i < dataRowCount; i++) {
         object cellValue = View.GetRowCellValue(i, col);
         double newValue = Convert.ToDouble(cellValue) * 0.9;
         View.SetRowCellValue(i, col, newValue);
      }
   } finally { View.EndSort(); }
}

VB.NET

Private Sub UpdatePrice(ByVal View As DevExpress.XtraGrid.Views.Base.ColumnView)
   ' Obtain the Price column. 
   Dim Col As DevExpress.XtraGrid.Columns.GridColumn = View.Columns.ColumnByFieldName("Price")
   If Col Is Nothing Then Exit Sub 
   View.BeginSort()
   Try 
      ' Obtain the number of data rows. 
      Dim DataRowCount As Integer = View.DataRowCount
      ' Traverse data rows and change the Price field values. 
      Dim I As Integer 
      For I = 0 To DataRowCount - 1
         Dim CellValue As Object = View.GetRowCellValue(I, Col)
         Dim NewValue As Double = Convert.ToDouble(CellValue) * 0.9
         View.SetRowCellValue(I, Col, NewValue)
      Next 
   Finally 
      View.EndSort()
   End Try 
End Sub 

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SetRowCellValue(Int32, String, Object) method.

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#

winforms-grid-enable-editing-in-group-row-to-change-cell-values/CS/WindowsApplication3/GroupEditProvider.cs#L188

    int childRowHandle = view.GetChildRowHandle(groupRowHandle, i);
    view.SetRowCellValue(childRowHandle, fieldName, edit.EditValue);
}

winforms-grid-display-editors-in-columns-headers/CS/WindowsApplication1/Form1.cs#L51

{
    gridView1.SetRowCellValue(i, "Check", (sender as CheckEdit).Checked);
}

VB.NET

winforms-grid-enable-editing-in-group-row-to-change-cell-values/VB/WindowsApplication3/GroupEditProvider.vb#L180

    Dim childRowHandle As Integer = view.GetChildRowHandle(groupRowHandle, i)
    view.SetRowCellValue(childRowHandle, fieldName, edit.EditValue)
Next i

winforms-grid-display-editors-in-columns-headers/VB/Form1.vb#L48

For i As Integer = 0 To gridView1.DataRowCount - 1
    gridView1.SetRowCellValue(i, "Check", (TryCast(sender, CheckEdit)).Checked)
Next i