ASPxGridBase.GetSelectedFieldValues(String[]) Method

Returns the field values of selected data items (rows, cards, or records).

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

public List<object> GetSelectedFieldValues(
    params string[] fieldNames
)

VB.NET

Public Function GetSelectedFieldValues(
    ParamArray fieldNames As String()
) As List(Of Object)

Parameters

Name	Type	Description
fieldNames	String[]	The names of data source fields.

Returns

Type	Description
List<Object>	The list of field values.

Remarks

The GetSelectedFieldValues method allows you to get a single or multiple column values of selected rows.

ASPX

<dx:ASPxGridView ID="ASPxGridView1" runat="server" KeyFieldName="CustomerID" AutoGenerateColumns="False">
    <Columns>
        <dx:GridViewDataTextColumn FieldName="ContactName" VisibleIndex="0" />
        <%--...--%>
        <dx:GridViewDataTextColumn FieldName="Country" VisibleIndex="4" />
    </Columns>
    <SettingsBehavior AllowSelectByRowClick="true" />
</dx:ASPxGridView>

C#

// Get a single field value
var selectItems = ASPxGridView1.GetSelectedFieldValues("ContactName");

// Get multiple field values
var selectItems = ASPxGridView1.GetSelectedFieldValues("ContactName", "Country");

VB.NET

Private Sub SurroundingSub()
    ' Get a single field value
    Dim selectItems = ASPxGridView1.GetSelectedFieldValues("ContactName")

    ' Get multiple field values
    Dim selectItems = ASPxGridView1.GetSelectedFieldValues("ContactName", "Country")
End Sub

View Example: How to get column values of multiple selected rows

To get the values of selected and filtered data items, call the GetSelectedFieldValues(String[]) method.

Limitation

• When cell merge is enabled, the GetSelectedFieldValues property is not in effect.

Example

The code sample below calls the GetSelectedFieldValues method to obtain selected rows and deletes them from the grid.

View Example: ASPxGridView - How to Delete Selected Rows in a Grid

ASPX

<dx:ASPxGridView ID="grid" KeyFieldName="ID" runat="server" AutoGenerateColumns="False"
    ClientInstanceName="grid" OnCustomCallback="gridView_CustomCallback" >
    <Columns>
        <dx:GridViewCommandColumn VisibleIndex="0" ShowSelectCheckbox="True">
            <FooterTemplate>
                <dx:ASPxButton ID="buttonDel" AutoPostBack="false" runat="server" Text="Delete">
                    <ClientSideEvents Click="OnClickButtonDel" />
                </dx:ASPxButton>
            </FooterTemplate>
        </dx:GridViewCommandColumn>
        <%--...--%>
    </Columns>
    <Settings ShowFooter="True" />
</dx:ASPxGridView>

JS

function OnClickButtonDel(s, e) {
    grid.PerformCallback('Delete');
}

C#

protected void gridView_CustomCallback(object sender, ASPxGridViewCustomCallbackEventArgs e) {
    if(e.Parameters == "Delete") {
        table = GetTable();
        List<Object> selectItems = grid.GetSelectedFieldValues("ID");
        foreach(object selectItemId in selectItems) {
            table.Rows.Remove(table.Rows.Find(selectItemId));
        }
        grid.DataBind();
        grid.Selection.UnselectAll();
    }
}

VB.NET

Protected Sub gridView_CustomCallback(ByVal sender As Object, ByVal e As ASPxGridViewCustomCallbackEventArgs)
    If e.Parameters = "Delete" Then
        table = GetTable()
        Dim selectItems As List(Of Object) = grid.GetSelectedFieldValues("ID")

        For Each selectItemId As Object In selectItems
            table.Rows.Remove(table.Rows.Find(selectItemId))
        Next

        grid.DataBind()
        grid.Selection.UnselectAll()
    End If
End Sub

Get the Values of Complex Fields

The GetSelectedFieldValues method returns column values only. So, if a grid is bound to a collection of complex objects (for example, KeyFieldName="Product.Category.CategoryName"), create a hidden column for this complex field. The grid does not render hidden columns, but allows you to get their data on the server side.

Web Forms Example

C#

ASPxGridView1.Columns.Add("SubRegionInfo.ID").Visible = false;

VB.NET

ASPxGridView1.Columns.Add("SubRegionInfo.ID").Visible = False

MVC Example

Razor

settings.Columns.Add("SubRegionInfo.ID").Visible = false;

Get Values in Server Mode

To get the key values of selected and filtered rows in Server Mode, set the SelectionStoringMode property to DataIntegrityOptimized.

If you assign the composite key to the KeyFieldName property, you can pass each key field name as a parameter to the GetSelectedFieldValues method.

In Server Mode, the GetSelectedFieldValues method does not return the non-key values of selected and filtered rows. Use the key values to obtain other values from a database directly:

C#

// For a single key value
query.FirstOrDefault(q => q.KeyProperty == "MyKeyValue")

//For a composite key value
query.FirstOrDefault(q => q.KeyProperty1 == "MyKeyValue1" && q.KeyProperty2 == "MyKeyValue2" && ...)

VB.NET

' For a single key value
query.FirstOrDefault(Function(q) q.KeyProperty = "MyKeyValue")

' For a composite key value
query.FirstOrDefault(Function(q) q.KeyProperty1 = "MyKeyValue1" AndAlso q.KeyProperty2 = "MyKeyValue2" AndAlso _._._._)

Online Example

View Example: How to move selected rows between grid controls

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetSelectedFieldValues(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-lookup-access-selected-data/CS/ASPxGridLookUpSelection/ServerSide_MultiSelect.aspx.cs#L12

ASPxGridView grid = ASPxGridLookup1.GridView;
List<object> fieldValues = grid.GetSelectedFieldValues(new string[] { "ProductName" });
ASPxListBox1.Items.Clear();

asp-net-web-forms-grid-get-column-values-of-multiple-selected-rows/CS/GetSelectedValuesAllColumns/Default.aspx.cs#L51

            fieldNames.Add(((GridViewDataColumn)column).FieldName);
    selectedValues = ASPxGridView1.GetSelectedFieldValues(fieldNames.ToArray());
}

VB.NET

asp-net-web-forms-grid-move-selected-rows-between-grid-controls/VB/E2636/Default.aspx.vb#L26

Case "addSelectedRows"
    rowValues = SourceGrid.GetSelectedFieldValues(fieldNames)
    Dim categoryIDs = New StringBuilder()

asp-net-web-forms-grid-lookup-access-selected-data/VB/ASPxGridLookUpSelection/ServerSide_MultiSelect.aspx.vb#L14

Dim grid As ASPxGridView = ASPxGridLookup1.GridView
Dim fieldValues As List(Of Object) = grid.GetSelectedFieldValues(New String() { "ProductName" })
ASPxListBox1.Items.Clear()

asp-net-web-forms-grid-get-column-values-of-multiple-selected-rows/VB/GetSelectedValuesAllColumns/Default.aspx.vb#L55

    Next column
    selectedValues = ASPxGridView1.GetSelectedFieldValues(fieldNames.ToArray())
End Sub