FindNearestItem Method

ListViewItem.FindNearestItem Method (SearchDirectionHint)

 

Finds the next item from the ListViewItem, searching in the specified direction.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public ListViewItem FindNearestItem(
	SearchDirectionHint searchDirection
)

Parameters

searchDirection
Type: System.Windows.Forms.SearchDirectionHint

One of the SearchDirectionHint values.

Return Value

Type: System.Windows.Forms.ListViewItem

The ListViewItem that is closest to the given coordinates, searching in the specified direction.

Exception Condition
InvalidOperationException

The View property of the containing ListView is set to a value other than SmallIcon or LargeIcon.

The FindNearestItem method returns null if no item is found in the given direction.

Identifying the nearest item can vary depending on the operating system the application is running on and will affect the results of FindNearestItem.

The following code example demonstrates how to use the FindNearestItem method. To run this example, paste the following code into a Windows Form that contains a ListView named findListView. Ensure that the View property is set to an icon view and that the ListView is populated with items. Associate the MouseDown event of findListView with the findListView_MouseDown method in this example.

void findListView_MouseDown(object sender, MouseEventArgs e)
{
    ListViewHitTestInfo info = findListView.HitTest(e.X, e.Y);
    ListViewItem foundItem = null;
    if (info.Item != null)
        foundItem = info.Item.FindNearestItem(SearchDirectionHint.Up);
    if (foundItem != null)
        label1.Text = "Previous Item: " + foundItem.Text;

    else
        label1.Text = "No item found";
}

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft