ASPxGridBase.GetSelectedFieldValues(String[]) Method

Returns the values displayed in all selected data items (rows, cards or records).

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v20.2.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 whose values are returned.

Returns

Type	Description
List<Object>	The list of objects that contain values displayed in the selected data items.

Remarks

Use the GetSelectedFieldValues method to get a single column as well as multiple column values of selected rows.

To get keys (including compound key values) of selected rows that were filtered when the grid operates in Server Mode, do the following:

• Set the ASPxGridBehaviorSettings.SelectionStoringMode property to GridViewSelectionStoringMode.DataIntegrityOptimized.
• Set a field whose names are sent as inner parameters to the GetSelectedFieldValues method as a key field. If you have assigned a compound KeyFieldName, you can use all the key field names as inner parameters of the GetSelectedFieldValues method.
• Use key field values to obtain other row values from a database directly, since the GetSelectedFieldValues method does not return non-key values of selected rows in Server mode.

For a single key:

C#

query.FirstOrDefault(q => q.KeyProperty == "MyKeyValue")

For a compound key:

C#

query.FirstOrDefault(q => q.KeyProperty1  == "MyKeyValue1" && q.KeyProperty2 == "MyKeyValue2" && ...)

Note

• The GetSelectedFieldValues property is not in effect if cell merging is enabled.

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

  MVC approach:

  Razor

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

  Web Forms approach:

  C#

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

The following example illustrates how to use the GetSelectedFieldValues method to obtain the “ProductName” field’s value of the ASPxGridView’s selected row.

C#

protected void ASPxButton1_Click(object sender, EventArgs e)
{
    var products = ASPxGridView1.GetSelectedFieldValues("ProductName");
    ASPxLabel1.Text = products[0].ToString();
}

ASPX

<dx:ASPxButton ID="ASPxButton1" runat="server" Text="Get Value" OnClick="ASPxButton1_Click"/>
<dx:ASPxLabel ID="ASPxLabel1" runat="server" ClientInstanceName="label" Text="Test"/>
<dx:ASPxGridView ID="ASPxGridView1" runat="server" ClientInstanceName="grid"
    DataSourceID="AccessDataSource1" KeyFieldName="ProductID" AutoGenerateColumns="False">
    <SettingsBehavior AllowSelectSingleRowOnly="true" AllowSelectByRowClick="true" />
    <Columns>
        <dx:GridViewCommandColumn VisibleIndex="0" ShowSelectCheckbox="true">
        </dx:GridViewCommandColumn>
        <dx:GridViewDataTextColumn FieldName="ProductID" ReadOnly="True" VisibleIndex="1">
            <EditFormSettings Visible="False" />
        </dx:GridViewDataTextColumn>
        <dx:GridViewDataTextColumn FieldName="ProductName" VisibleIndex="2">
        </dx:GridViewDataTextColumn>
        <dx:GridViewDataTextColumn FieldName="UnitPrice" VisibleIndex="3">
        </dx:GridViewDataTextColumn>
        <dx:GridViewDataTextColumn FieldName="UnitsOnOrder" VisibleIndex="4">
        </dx:GridViewDataTextColumn>
    </Columns>
</dx:ASPxGridView>

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#

aspxgridview-how-to-keep-selection-when-expanding-collapsing-detail-grids-e4685/CS/Default.aspx.cs#L49

object masterKey = grid.GetMasterRowKeyValue();
List<object> selectedKeys = grid.GetSelectedFieldValues(new string[] { "ProductID" });

aspxgridview-how-to-expand-a-current-group-row-if-one-of-the-child-rows-is-selected-e2148/CS/WebSite/Default.aspx.cs#L20

{
    List<object> selectedKeys = ASPxGridView1.GetSelectedFieldValues("ProductID") as List<object>;
    for (int i = 0; i<ASPxGridView1.VisibleRowCount; i++)

how-to-adjust-aspxgridlookup-selection-e4742/CS/ASPxGridLookUpSelection/ServerSide_MultiSelect.aspx.cs#L12

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

VB.NET

aspxgridview-how-to-keep-selection-when-expanding-collapsing-detail-grids-e4685/VB/Default.aspx.vb#L54

Dim masterKey As Object = grid.GetMasterRowKeyValue()
Dim selectedKeys As List(Of Object) = grid.GetSelectedFieldValues(New String() { "ProductID" })

aspxgridview-how-to-expand-a-current-group-row-if-one-of-the-child-rows-is-selected-e2148/VB/WebSite/Default.aspx.vb#L18

Protected Sub ASPxGridView1_DataBound(ByVal sender As Object, ByVal e As EventArgs)
    Dim selectedKeys As List(Of Object) = TryCast(ASPxGridView1.GetSelectedFieldValues("ProductID"), List(Of Object))
    For i As Integer = 0 To ASPxGridView1.VisibleRowCount - 1

how-to-adjust-aspxgridlookup-selection-e4742/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()