ASPxGridColumnDataEventArgs.GetListSourceFieldValue(Int32, String) Method

Returns the value of the specified field in the specified data item (row, card or record) in the control’s underlying data source.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v23.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

public object GetListSourceFieldValue(
    int listSourceRowIndex,
    string fieldName
)

VB.NET

Public Function GetListSourceFieldValue(
    listSourceRowIndex As Integer,
    fieldName As String
) As Object

Parameters

Name	Type	Description
listSourceRowIndex	Int32	An integer value specifying the data item’s index.
fieldName	String	A string that specifies the required field name.

Returns

Type	Description
Object	An object that is a value from the control’s data source.

Remarks

The GetListSourceFieldValue method returns a value from the specified cell in the control’s underlying data source. The cell is identified by the data item’s index and field name. To get the index of the processed data item, use the ASPxGridColumnDataEventArgs.ListSourceRowIndex property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetListSourceFieldValue(Int32, String) 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#

asp-net-web-forms-grid-editable-unbound-columns/CS/UnboundColumnForCommenting/Default.aspx.cs#L40

if(e.IsGetData && e.Column.FieldName == "Comment") {
    object key = e.GetListSourceFieldValue(e.ListSourceRowIndex, ASPxGridView1.KeyFieldName);
    e.Value = MyComments.GetComment(key);

VB.NET

asp-net-web-forms-grid-editable-unbound-columns/VB/UnboundColumnForCommenting/Default.aspx.vb#L42

If e.IsGetData AndAlso e.Column.FieldName = "Comment" Then
    Dim key As Object = e.GetListSourceFieldValue(e.ListSourceRowIndex, ASPxGridView1.KeyFieldName)
    e.Value = MyComments.GetComment(key)