DataControlBase.GetSelectedRowHandles() Method

Returns the handles of the selected rows.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v19.2.Core.dll

Declaration

C#

public int[] GetSelectedRowHandles()

VB.NET

Public Function GetSelectedRowHandles As Integer()

Returns

Type	Description
Int32[]	An array of integer values representing the handles of the selected rows. An empty array if no rows are selected.

Remarks

Multiple rows can be selected when the TableView.MultiSelectMode option is set to MultiSelectMode.Row or MultiSelectMode.MultipleRow. You can use the GetSelectedRowHandles method to obtain the handles of the selected rows. Also, the DataControlBase.SelectedItems property returns the collection of currently selected rows/nodes.

When multiple selection is disabled, the GetSelectedRowHandles method returns an array containing a single element that represents the focused row handle. This value can also be obtained using the DataViewBase.FocusedRowHandle property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetSelectedRowHandles() 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#

how-to-preserve-the-dxgrid-for-wpf-view-state-e4222/CS/SaveWpfGridState/RowStateHelper.cs#L239

SelectionList.Clear();
var selectedRows = gridControl.GetSelectedRowHandles();
for (int i = 0; i < selectedRows.Length; i++) {

drag-drop-in-treelist-and-gridcontrol-how-to-show-dragged-rows-as-a-cursor-e4165/CS/DragDropRows/CustomGridDragDropManager.cs#L28

List<object> images = new List<object>();
foreach (int rowHandle in view.DataControl.GetSelectedRowHandles()) {
    FrameworkElement element = view.GetRowElementByRowHandle(rowHandle);

VB.NET

how-to-preserve-the-dxgrid-for-wpf-view-state-e4222/VB/SaveWpfGridState/RowStateHelper.vb#L265

SelectionList.Clear()
Dim selectedRows = gridControl.GetSelectedRowHandles()
For i As Integer = 0 To selectedRows.Length - 1

drag-drop-in-treelist-and-gridcontrol-how-to-show-dragged-rows-as-a-cursor-e4165/VB/DragDropRows/CustomGridDragDropManager.vb#L35

Dim images As New List(Of Object)()
For Each rowHandle As Integer In view.DataControl.GetSelectedRowHandles()
    Dim element As FrameworkElement = view.GetRowElementByRowHandle(rowHandle)