ListView.HitTest Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides item information, given an x- and y-coordinate.
Overloads
HitTest(Point) |
Provides item information, given a point. |
HitTest(Int32, Int32) |
Provides item information, given x- and y-coordinates. |
HitTest(Point)
Provides item information, given a point.
public:
System::Windows::Forms::ListViewHitTestInfo ^ HitTest(System::Drawing::Point point);
public System.Windows.Forms.ListViewHitTestInfo HitTest (System.Drawing.Point point);
member this.HitTest : System.Drawing.Point -> System.Windows.Forms.ListViewHitTestInfo
Public Function HitTest (point As Point) As ListViewHitTestInfo
Parameters
- point
- Point
The Point at which to retrieve the item information. The coordinates are relative to the upper-left corner of the control.
Returns
The item information, given a point.
Exceptions
The point contains coordinates that are less than 0.
Remarks
Use this method to determine whether a point is in an item or subitem and where in the item the point is located, such as on the label or image area. If the coordinates are located outside the control, the returned ListViewHitTestInfo object has a Location property of "None"; and the Item and SubItem properties are set to null
.
Applies to
HitTest(Int32, Int32)
Provides item information, given x- and y-coordinates.
public:
System::Windows::Forms::ListViewHitTestInfo ^ HitTest(int x, int y);
public System.Windows.Forms.ListViewHitTestInfo HitTest (int x, int y);
member this.HitTest : int * int -> System.Windows.Forms.ListViewHitTestInfo
Public Function HitTest (x As Integer, y As Integer) As ListViewHitTestInfo
Parameters
- x
- Int32
The x-coordinate at which to retrieve the item information. The coordinate is relative to the upper-left corner of the control.
- y
- Int32
The y-coordinate at which to retrieve the item information. The coordinate is relative to the upper-left corner of the control.
Returns
The item information, given x- and y- coordinates.
Exceptions
The x- or y-coordinate is less than 0.
Examples
The following code example demonstrates using the HitTest method to determine the location of a mouse event in a ListView. To run this example, paste it into a Windows Form that contains a ListView named listView1
that is populated with items. Associate the MouseDown event for listView1
with the listView1_MouseDown
method in this example.
void HandleMouseDown(object sender, MouseEventArgs e)
{
ListViewHitTestInfo info = listView1.HitTest(e.X, e.Y);
MessageBox.Show(info.Location.ToString());
}
Private Sub HandleMouseDown(ByVal sender As Object, ByVal e As MouseEventArgs) _
Handles Me.MouseDown, listView1.MouseDown
Dim info As ListViewHitTestInfo = listView1.HitTest(e.X, e.Y)
MessageBox.Show(info.Location.ToString())
End Sub
Remarks
Use this method to determine whether a point is in an item or subitem, and where in the item the point is located, such as on the label or image area. If the coordinates are located outside the control, the returned ListViewHitTestInfo object has a Location property of "None"; and the Item and SubItem properties are set to null
.