Skip to main content

GridViewSelection.SelectRowByKey(Object) Method

Selects the row specified by the key value.

Namespace: DevExpress.Web.Data

Assembly: DevExpress.Web.v22.1.dll

Declaration

public void SelectRowByKey(
    object keyValue
)

Parameters

Name Type Description
keyValue Object

The row’s key value.

Remarks

Use the SelectRowByKey and UnselectRowByKey(Object) methods to select and deselect the row specified by the key value.

For more information on row selection in the grid, refer to the following topic: Selection.

The code sample below gets the current selection state of the row with the specified key value and changes it.

<dx:ASPxGridView ID="gridview" ClientInstanceName="grid" runat="server" AutoGenerateColumns="False"
    KeyFieldName="ProductID" OnCustomCallback="gridview_CustomCallback">
    <Columns>
        <dx:GridViewCommandColumn ShowSelectCheckbox="true" VisibleIndex="0" />
        <%--...--%>
    </Columns>
</dx:ASPxGridView>
<br />
<dx:ASPxButton ID="ASPxButton1" runat="server" Text="Change selection state" AutoPostBack="false">
    <ClientSideEvents Click="onButtonClick" />
</dx:ASPxButton>
function onButtonClick(s, e) {
    grid.PerformCallback();
}
protected void gridview_CustomCallback(object sender, ASPxGridViewCustomCallbackEventArgs e) {
    var grid = sender as ASPxGridView;
    var rowKey = 6;
    if(grid.Selection.IsRowSelectedByKey(rowKey)) {
        grid.Selection.UnselectRowByKey(rowKey);
    } else {
        grid.Selection.SelectRowByKey(rowKey);
    }
}

Select the Row Specified by the Composite Key Value

<dx:ASPxGridView ID="grid" ClientInstanceName="grid" runat="server" KeyFieldName="ProductID;ProductName">
</dxASPxGridView>
grid.Selection.SelectRowByKey("2|Chang");
See Also