BingRouteResult.RoutePath Property

Returns a list of geographical points that together, comprise the route path.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v18.2.dll

Declaration

C#

public List<GeoPoint> RoutePath { get; }

VB.NET

Public ReadOnly Property RoutePath As List(Of GeoPoint)

Property Value

Type	Description
List<GeoPoint>	A list of GeoPoint objects.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-calculate-routes-from-major-roads-using-the-bing-map-route-web-service-e5064

Form1.cs

private void OnRouteCalculated(object sender, BingRouteCalculatedEventArgs e) {
    RouteCalculationResult result = e.CalculationResult;
    if((result.RouteResults == null) ||
        (result.ResultCode == RequestResultCode.BadRequest)) {
        rtbResults.Text = "The Bing Route service does not work for this location.";
        return;
    }

    StringBuilder resultList = new StringBuilder("");

    if(result.IntermediatePoints != null) {
        resultList.Append(String.Format("_________________________\n"));

        for(int i = 0; i < e.CalculationResult.IntermediatePoints.Count; i++)
            resultList.Append(
                String.Format("Starting point {0}: {1} ({2})\n",
                i + 1,
                e.CalculationResult.IntermediatePoints[i].Description,
                e.CalculationResult.IntermediatePoints[i].Location)
            );
    }

    if((result.RouteResults != null) & (result.ResultCode == RequestResultCode.Success)) {

        for(int rnum = 0; rnum < e.CalculationResult.RouteResults.Count; rnum++) {
            resultList.Append(String.Format("_________________________\n"));
            resultList.Append(String.Format("Path {0}:\n", rnum + 1));
            resultList.Append(String.Format(
                "Distance: {0}\n",
                e.CalculationResult.RouteResults[rnum].Distance
            ));
            resultList.Append(String.Format(
                "Time: {0}\n",
                e.CalculationResult.RouteResults[0].Time
            ));

            if(e.CalculationResult.RouteResults[rnum].Legs != null) {
                int legNum = 1;
                foreach(BingRouteLeg leg in e.CalculationResult.RouteResults[rnum].Legs) {
                    resultList.Append(String.Format("\tLeg {0}:\n", legNum++));
                    resultList.Append(String.Format("\tDistance: {0}\n", leg.Distance));
                    resultList.Append(String.Format("\tTime: {0}\n", leg.Time));
                    if(leg.Itinerary != null) {
                        foreach(BingItineraryItem itineraryItem in leg.Itinerary) {
                            resultList.Append(String.Format(itineraryItem.Maneuver + "\n"));
                            resultList.Append(String.Format(
                                "\t\tLocation: {0}\n",
                                itineraryItem.Location
                            ));
                        }
                    }
                }
            }
        }
    }
    rtbResults.Text = resultList.ToString();
}

Form1.vb

Private Sub OnRouteCalculated(ByVal sender As Object, ByVal e As BingRouteCalculatedEventArgs)
    Dim result As RouteCalculationResult = e.CalculationResult
    If (result.RouteResults Is Nothing) OrElse (result.ResultCode = RequestResultCode.BadRequest) Then
        rtbResults.Text = "The Bing Route service does not work for this location."
        Return
    End If

    Dim resultList As New StringBuilder("")

    If result.IntermediatePoints IsNot Nothing Then
        resultList.Append(String.Format("_________________________" & ControlChars.Lf))

        For i As Integer = 0 To e.CalculationResult.IntermediatePoints.Count - 1
            resultList.Append(String.Format("Starting point {0}: {1} ({2})" & ControlChars.Lf, i + 1, e.CalculationResult.IntermediatePoints(i).Description, e.CalculationResult.IntermediatePoints(i).Location))
        Next i
    End If

    If (result.RouteResults IsNot Nothing) And (result.ResultCode = RequestResultCode.Success) Then

        For rnum As Integer = 0 To e.CalculationResult.RouteResults.Count - 1
            resultList.Append(String.Format("_________________________" & ControlChars.Lf))
            resultList.Append(String.Format("Path {0}:" & ControlChars.Lf, rnum + 1))
            resultList.Append(String.Format("Distance: {0}" & ControlChars.Lf, e.CalculationResult.RouteResults(rnum).Distance))
            resultList.Append(String.Format("Time: {0}" & ControlChars.Lf, e.CalculationResult.RouteResults(0).Time))

            If e.CalculationResult.RouteResults(rnum).Legs IsNot Nothing Then
                Dim legNum As Integer = 1
                For Each leg As BingRouteLeg In e.CalculationResult.RouteResults(rnum).Legs
                    resultList.Append(String.Format(ControlChars.Tab & "Leg {0}:" & ControlChars.Lf, legNum))
                    legNum += 1
                    resultList.Append(String.Format(ControlChars.Tab & "Distance: {0}" & ControlChars.Lf, leg.Distance))
                    resultList.Append(String.Format(ControlChars.Tab & "Time: {0}" & ControlChars.Lf, leg.Time))
                    If leg.Itinerary IsNot Nothing Then
                        For Each itineraryItem As BingItineraryItem In leg.Itinerary
                            resultList.Append(String.Format(itineraryItem.Maneuver & ControlChars.Lf))
                            resultList.Append(String.Format(ControlChars.Tab & ControlChars.Tab & "Location: {0}" & ControlChars.Lf, itineraryItem.Location))
                        Next itineraryItem
                    End If
                Next leg
            End If
        Next rnum
    End If
    rtbResults.Text = resultList.ToString()
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RoutePath property.

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-implement-a-route-calculator-using-gis-providers-t187741/CS/WinForms_MapControl_GIS/Form1.cs#L81

if (e.CalculationResult.ResultCode == RequestResultCode.Success) {
    helper.BuildRoute(e.CalculationResult.RouteResults[0].RoutePath);
    UpdateStorage();

VB.NET

how-to-implement-a-route-calculator-using-gis-providers-t187741/VB/WinForms_MapControl_GIS/Form1.vb#L126

If e.CalculationResult.ResultCode = RequestResultCode.Success Then
    helper.BuildRoute(e.CalculationResult.RouteResults(0).RoutePath)
    UpdateStorage()