MapControl.CalcHitInfo(Point) Method

Returns information on the map elements located at the specified point.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v20.2.dll

NuGet Package: DevExpress.Win.Map

Declaration

C#

public MapHitInfo CalcHitInfo(
    Point hitPoint
)

VB.NET

Public Function CalcHitInfo(
    hitPoint As Point
) As MapHitInfo

Parameters

Name	Type	Description
hitPoint	Point	The hit point, relative to the map’s top-left edge integer screen coordinates.

Returns

Type	Description
MapHitInfo	The object containing information about the map elements located at the hit point.

Remarks

Use the CalcHitInfo method to determine which element is located at the specified hit point. For instance, this can be used when handling the map’s MouseDown event to determine which element was clicked. In such cases, pass the current mouse pointer’s coordinates as the method’s parameter.

Note

The returned MapHitInfo object does not contain the test point location in map coordinates. To obtain the location, use the MapControl.ScreenPointToCoordPoint method.

Example

C#

mapControl1.MouseClick += OnMapControlMouseClick;
//...
private void OnMapControlMouseClick(object sender, MouseEventArgs e) {
    MapHitInfo info = mapControl1.CalcHitInfo(e.Location);
    if (info.InMapSpline) {
        gridControl1.DataSource = info.MapSpline.Points;           
    }
}

VB.NET

mapControl1.MouseClick += OnMapControlMouseClick
'...
Private Sub OnMapControlMouseClick(ByVal sender As Object, ByVal e As MouseEventArgs)
    Dim info As MapHitInfo = mapControl1.CalcHitInfo(e.Location)
    If info.InMapSpline Then
        gridControl1.DataSource = info.MapSpline.Points
    End If
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CalcHitInfo(Point) 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-move-a-map-pushpin-element-at-runtime-t190789/CS/MoveMapItems/Form1.cs#L30

private void mapControl1_MouseDown(object sender, MouseEventArgs e) {
    MapHitInfo info = this.mapControl1.CalcHitInfo(e.Location);
    if (info.InMapPushpin) {

VB.NET

how-to-move-a-map-pushpin-element-at-runtime-t190789/VB/MoveMapItems/Form1.vb#L32

Private Sub mapControl1_MouseDown(ByVal sender As Object, ByVal e As MouseEventArgs) Handles mapControl1.MouseDown
    Dim info As MapHitInfo = Me.mapControl1.CalcHitInfo(e.Location)
    If info.InMapPushpin Then