BingGeocodeDataProvider.LocationInformationReceived Event

Occurs when information about the location has been received.

Namespace: DevExpress.Xpf.Map

Assembly: DevExpress.Xpf.Map.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Map, DevExpress.Wpf.Map

Declaration

C#

public event LocationInformationReceivedEventHandler LocationInformationReceived

VB.NET

Public Event LocationInformationReceived As LocationInformationReceivedEventHandler

Event Data

The LocationInformationReceived event's data class is LocationInformationReceivedEventArgs. The following properties provide information specific to this event:

Property	Description
Cancelled	Gets a value indicating whether an asynchronous operation has been canceled. Inherited from AsyncCompletedEventArgs.
Error	Gets a value indicating which error occurred during an asynchronous operation. Inherited from AsyncCompletedEventArgs.
Result	Returns the result of a request to obtain information about a specific geographical coordinate.
UserState	Gets the unique identifier for the asynchronous task. Inherited from AsyncCompletedEventArgs.

The event data class exposes the following methods:

Method	Description
RaiseExceptionIfNecessary()	Raises a user-supplied exception if an asynchronous operation failed. Inherited from AsyncCompletedEventArgs.

Example

This example demonstrates how to manually process received Bing Geocode location information.

• Create a InformationLayer object and add it to the MapControl.Layers collection. Assign the BingGeocodeDataProvider object to the InformationLayer.DataProvider property.
• Handle the BingGeocodeDataProvider.LocationInformationReceived event. In the event handler, implement the request result processing.

Note

If you run the application, and see a window with the following error message: ”The specified Bing Maps key is invalid. To create a developer account, refer to https://www.microsoft.com/en-us/maps/create-a-bing-maps-key”, refer to the following tutorial: How to: Get a Bing Maps Key.

View Example

MainWindow.xaml

<dxm:BingGeocodeDataProvider x:Name="geocodeProvider"   ProcessMouseEvents="False"
    BingKey="{Binding Source={StaticResource YourBingKey}}" 
    LocationInformationReceived="geocodeProvider_LocationInformationReceived"/>

MainWindow.xaml.cs

private void geocodeProvider_LocationInformationReceived(object sender, LocationInformationReceivedEventArgs e) {
    GeocodeRequestResult result = e.Result;
    StringBuilder resultList = new StringBuilder("");
    resultList.Append(String.Format("Status: {0}\n", result.ResultCode));
    resultList.Append(String.Format("Fault reason: {0}\n", result.FaultReason));
    resultList.Append(String.Format("______________________________\n"));

    if (result.ResultCode != RequestResultCode.Success) {
        tbResults.Text = resultList.ToString();
        return; 
    }

    int resCounter = 1;
    foreach (LocationInformation locations in result.Locations) {
        resultList.Append(String.Format("Request Result {0}:\n", resCounter));
        resultList.Append(String.Format("Display Name: {0}\n", locations.DisplayName));
        resultList.Append(String.Format("Entity Type: {0}\n", locations.EntityType));
        resultList.Append(String.Format("Address: {0}\n", locations.Address));
        resultList.Append(String.Format("Location: {0}\n", locations.Location));
        resultList.Append(String.Format("______________________________\n"));
        resCounter++;
    }

    tbResults.Text = resultList.ToString();
}

MainWindow.xaml.vb

Private Sub geocodeProvider_LocationInformationReceived(ByVal sender As Object, ByVal e As LocationInformationReceivedEventArgs)
    Dim result As GeocodeRequestResult = e.Result
    Dim resultList As New StringBuilder("")
    resultList.Append(String.Format("Status: {0}" & ControlChars.Lf, result.ResultCode))
    resultList.Append(String.Format("Fault reason: {0}" & ControlChars.Lf, result.FaultReason))
    resultList.Append(String.Format("______________________________" & ControlChars.Lf))

    If result.ResultCode <> RequestResultCode.Success Then
        tbResults.Text = resultList.ToString()
        Return
    End If

    Dim resCounter As Integer = 1
    For Each locations As LocationInformation In result.Locations
        resultList.Append(String.Format("Request Result {0}:" & ControlChars.Lf, resCounter))
        resultList.Append(String.Format("Display Name: {0}" & ControlChars.Lf, locations.DisplayName))
        resultList.Append(String.Format("Entity Type: {0}" & ControlChars.Lf, locations.EntityType))
        resultList.Append(String.Format("Address: {0}" & ControlChars.Lf, locations.Address))
        resultList.Append(String.Format("Location: {0}" & ControlChars.Lf, locations.Location))
        resultList.Append(String.Format("______________________________" & ControlChars.Lf))
        resCounter += 1
    Next locations

    tbResults.Text = resultList.ToString()
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LocationInformationReceived event.

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.

XAML

how-to-implement-a-route-calculator-t190068/CS/MapControl_RouteCalculator/MainWindow.xaml#L34

                                 GenerateLayerItems="False"
                                 LocationInformationReceived="LocationInformationReceived"/>
</dxm:InformationLayer.DataProvider>

how-to-get-information-about-a-geopoint-using-the-bing-geocode-web-service-e4258/CS/GetLocationInformation/MainWindow.xaml#L31

    BingKey="{Binding Source={StaticResource YourBingKey}}"
    LocationInformationReceived="geocodeProvider_LocationInformationReceived"/>
<!--endregion #LocationInformationReceived-->