ColumnView.GetListSourceRowCellValue(Int32, GridColumn) Method

Returns the value of the specified cell, which is identified by a column and the index of a record in the data source.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public object GetListSourceRowCellValue(
    int listSourceRowIndex,
    GridColumn column
)

VB.NET

Public Function GetListSourceRowCellValue(
    listSourceRowIndex As Integer,
    column As GridColumn
) As Object

Parameters

Name	Type	Description
listSourceRowIndex	Int32	An integer value representing the index of the record in the underlying data source.
column	GridColumn	A GridColumn object identifying a field in the data source.

Returns

Type	Description
Object	An object representing the required cell’s value.

Remarks

This method takes the index of a record in the data source as a parameter. Typically, you use this method to get row values while handling specific events (ColumnView.CustomUnboundColumnData and ColumnView.CustomColumnSort). These events provide ListSourceRowIndex parameters which identify currently processed rows. Use these parameters to identify rows while calling the GetListSourceRowCellValue method.

To get row values based on indexes or rows in the grid control, use the ColumnView.GetRowCellValue method.

Note

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

• 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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetListSourceRowCellValue(Int32, GridColumn) 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#

how-create-file-manager-using-gridcontrol-e3053/CS/GridCommander/CommanderTab.cs#L100

if(e.Column == colName) {
    string s = (string)view.GetListSourceRowCellValue(e.ListSourceRowIndex, colFullName);
    if((_parent != null) && (s == _parent.FullName))

how-to-calculate-summary-using-summary-values-calculated-by-other-columns-e2488/CS/Q273845/Form1.cs#L63

if(e.IsGetData)
    e.Value = Convert.ToDecimal(view.GetListSourceRowCellValue(e.ListSourceRowIndex, colUnitPrice)) *
        Convert.ToInt32(view.GetListSourceRowCellValue(e.ListSourceRowIndex, colUnitsInStock));

how-to-convert-rtf-data-to-plain-text-when-displaying-in-xtragrid-e1772/CS/WindowsApplication289/Form1.cs#L34

if (e.Column.FieldName == "PlainNotes" && e.IsGetData) {
    object value = ((GridView)sender).GetListSourceRowCellValue(e.ListSourceRowIndex, gridColumn3);
    richServer.RtfText = value.ToString();

how-to-filter-against-a-grid-column-that-displays-rtf-data-e2907/CS/E2907/Form1.cs#L36

if(e.Column.FieldName == "SimpleText" && e.IsGetData) {
    object value = ((GridView)sender).GetListSourceRowCellValue(e.ListSourceRowIndex, colDescription);
    e.Value = repositoryItemRichTextEdit1.ConvertEditValueToPlainText(value);

how-to-customize-the-gridcontrols-data-aware-export-output-t247610/CS/GridDataAwareExportCustomization/Form1.cs#L33

if(e.IsGetData) {
    int id = (int)view.GetListSourceRowCellValue(e.ListSourceRowIndex, colCategoryID);
    e.Value = nwindDataSet.Categories.FindByCategoryID(id).CategoryName;

VB.NET

how-create-file-manager-using-gridcontrol-e3053/VB/GridCommander/CommanderTab.vb#L108

If e.Column Is colName Then
    Dim s As String = CStr(view.GetListSourceRowCellValue(e.ListSourceRowIndex, colFullName))
    If (_parent IsNot Nothing) AndAlso (s = _parent.FullName) Then

how-to-convert-rtf-data-to-plain-text-when-displaying-in-xtragrid-e1772/VB/WindowsApplication289/Form1.vb#L32

If e.Column.FieldName = "PlainNotes" AndAlso e.IsGetData Then
    Dim value As Object = (CType(sender, GridView)).GetListSourceRowCellValue(e.ListSourceRowIndex, gridColumn3)
    richServer.RtfText = value.ToString()

how-to-calculate-summary-using-summary-values-calculated-by-other-columns-e2488/VB/Q273845/Form1.vb#L49

If e.Column Is colPrice Then
    If e.IsGetData Then e.Value = Convert.ToDecimal(view.GetListSourceRowCellValue(e.ListSourceRowIndex, colUnitPrice)) * Convert.ToInt32(view.GetListSourceRowCellValue(e.ListSourceRowIndex, colUnitsInStock))
End If

how-to-filter-against-a-grid-column-that-displays-rtf-data-e2907/VB/E2907/Form1.vb#L36

If e.Column.FieldName = "SimpleText" AndAlso e.IsGetData Then
    Dim value As Object = (CType(sender, GridView)).GetListSourceRowCellValue(e.ListSourceRowIndex, colDescription)
    e.Value = repositoryItemRichTextEdit1.ConvertEditValueToPlainText(value)

how-to-customize-the-gridcontrols-data-aware-export-output-t247610/VB/GridDataAwareExportCustomization/Form1.vb#L34

If e.IsGetData Then
    Dim id As Integer = CInt(view.GetListSourceRowCellValue(e.ListSourceRowIndex, colCategoryID))
    e.Value = nwindDataSet.Categories.FindByCategoryID(id).CategoryName