ColumnView.GetRowCellValue(Int32, GridColumn) Method

Returns a specific cell value from the current View.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v21.2.dll

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

Declaration

C#

public virtual object GetRowCellValue(
    int rowHandle,
    GridColumn column
)

VB.NET

Public Overridable Function GetRowCellValue(
    rowHandle As Integer,
    column As GridColumn
) As Object

Parameters

Name	Type	Description
rowHandle	Int32	An integer value representing a handle of the row where the desired cell resides. Row handles are not data source indexes, see the Accessing Rows in Code. Row Handles section of the “Rows” article for more information.
column	GridColumn	A GridColumn object or descendant representing a column that contains the desired cell.

Returns

Type	Description
Object	An object that is the specified cell’s value. null (Nothing in Visual Basic) if the specified cell is not found. In Instant Feedback Mode, an invalid “Non-loaded Value” is immediately returned if the requested cell is not currently loaded.

Remarks

The method returns null (Nothing in Visual Basic) in the following cases:

• the specified row handle doesn’t point to any of the rows within the current View or points to a group row;
• the specified column doesn’t belong to the View or is a null reference.

Note

In Instant Feedback Mode, this GetRowCellValue method has limitations. It returns a correct value only if the target row has been loaded. Otherwise, it returns a “Non-loaded Value”. You can check to see whether or not the returned value is the “Non-loaded Value” by calling the static BaseEdit.IsNotLoadedValue method.

If you require this value right away (e.g., on a Custom Draw event), skip this value by adding a code, similar to the following:

C#

private void gridView1_CustomDrawGroupRow(object sender, DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs e) {
    GridView view = sender as GridView;
    int index = view.GetDataRowHandleByGroupRowHandle(e.RowHandle);
    var cellValue = view.GetRowCellValue(index, "Mode");
    if (BaseEdit.IsNotLoadedValue(cellValue)) {
        ((GridGroupRowInfo)e.Info).GroupText = "Loading...";
    }
    else {
        int mode = (int)cellValue;
        ((GridGroupRowInfo)e.Info).GroupText += "custom " + mode;
    }
}

VB.NET

Private Sub gridView1_CustomDrawGroupRow(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs)
    Dim view As GridView = TryCast(sender, GridView)
    Dim index As Integer = view.GetDataRowHandleByGroupRowHandle(e.RowHandle)
    Dim cellValue = view.GetRowCellValue(index, "Mode")
    If BaseEdit.IsNotLoadedValue(cellValue) Then
        CType(e.Info, GridGroupRowInfo).GroupText = "Loading..."
    Else
        Dim mode As Integer = CInt(Math.Truncate(cellValue))
        CType(e.Info, GridGroupRowInfo).GroupText &= "custom " & mode
    End If
End Sub

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetRowCellValue member must not be invoked for these Views. The GetRowCellValue 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