GridViewSelection.IsRowSelectedByKey(Object) Method

Indicates whether the specified row is selected.

Namespace: DevExpress.Web.Data

Assembly: DevExpress.Web.v23.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

public bool IsRowSelectedByKey(
    object keyValue
)

VB.NET

Public Function IsRowSelectedByKey(
    keyValue As Object
) As Boolean

Parameters

Name	Type	Description
keyValue	Object	The key value of the row.

Returns

Type	Description
Boolean	true if the specified row is selected; otherwise, false.

Remarks

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.

ASPX

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

JS

function onButtonClick(s, e) {
    grid.PerformCallback();
}

C#

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);
    }
}

VB.NET

Protected Sub gridview_CustomCallback(ByVal sender As Object, ByVal e As ASPxGridViewCustomCallbackEventArgs)
    Dim grid = TryCast(sender, ASPxGridView)
    Dim rowKey = 6

    If grid.Selection.IsRowSelectedByKey(rowKey) Then
        grid.Selection.UnselectRowByKey(rowKey)
    Else
        grid.Selection.SelectRowByKey(rowKey)
    End If
End Sub

Get the Selection State of the Row Specified by the Composite Key Value

ASPX

<dx:ASPxGridView ID="grid" ClientInstanceName="grid" runat="server" KeyFieldName="ProductID;ProductName">
</dxASPxGridView>

C#

grid.Selection.IsRowSelectedByKey("2|Chang");

VB.NET

grid.Selection.IsRowSelectedByKey("2|Chang")