AzureSearchDataProvider.SearchCompleted Event

Occurs when a search operation has been completed.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v26.1.dll

NuGet Package: DevExpress.Win.Map

Declaration

C#

public event AzureSearchCompletedEventHandler SearchCompleted

VB.NET

Public Event SearchCompleted As AzureSearchCompletedEventHandler

Event Data

The SearchCompleted event's data class is AzureSearchCompletedEventArgs. 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.
RequestResult	Returns the result of the search request. Inherited from SearchCompletedEventArgs.
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.

Remarks

To obtain search results for received GIS data, do the following:

1. Handle the SearchCompleted event.
2. In the event handler, read the e.RequestResult.SearchResults to obtain an array of LocationInformation objects.

The following image illustrates the result:

C#

using DevExpress.XtraMap;
// ...
const string azureKey = "your key";
// ...
AzureSearchDataProvider azureSearchProvider = new AzureSearchDataProvider() {
    AzureKey = azureKey,
};
azureSearchProvider.Search("Redmond 15127 NE 24th St");

azureSearchProvider.SearchCompleted += new AzureSearchCompletedEventHandler(OnSearchCompleted);
void OnSearchCompleted(object sender, AzureSearchCompletedEventArgs e) {
    if (e.Cancelled) return;
    if (e.RequestResult.ResultCode != RequestResultCode.Success) {
        MessageBox.Show("The Azure Search service does not work for this location.");
        return;
    }
    StringBuilder resultList = new StringBuilder("");
    int resCounter = 1;
    foreach (LocationInformation resultInfo in e.RequestResult.SearchResults) {
        resultList.Append(String.Format("Result {0}:  \r\n", resCounter));
        resultList.Append(String.Format("Address: {0}\r\n", resultInfo.Address.FormattedAddress));
        resultList.Append(String.Format("Geographic coordinates:  {0}\r\n", resultInfo.Location));
        resultList.Append(String.Format("______________________________\r\n"));
        resCounter++;
    }
    MessageBox.Show(resultList.ToString());
}
InformationLayer informationLayer = new InformationLayer();
informationLayer.DataProvider = azureSearchProvider;
map.Layers.Add(informationLayer);

VB.NET

Imports DevExpress.XtraMap
' ...
Private Const azureKey As String = "your key"
' ...
Dim azureSearchProvider As New AzureSearchDataProvider() With {.AzureKey = azureKey}
azureSearchProvider.Search("Redmond 15127 NE 24th St")

Private azureSearchProvider.SearchCompleted += New AzureSearchCompletedEventHandler(AddressOf OnSearchCompleted)
Private Sub OnSearchCompleted(ByVal sender As Object, ByVal e As AzureSearchCompletedEventArgs)
    If e.Cancelled Then
        Return
    End If
    If e.RequestResult.ResultCode <> RequestResultCode.Success Then
        MessageBox.Show("The Azure Search service does not work for this location.")
        Return
    End If
    Dim resultList As New StringBuilder("")
    Dim resCounter As Integer = 1
    For Each resultInfo As LocationInformation In e.RequestResult.SearchResults
        resultList.Append(String.Format("Result {0}:  " & vbCrLf, resCounter))
        resultList.Append(String.Format("Address: {0}" & vbCrLf, resultInfo.Address.FormattedAddress))
        resultList.Append(String.Format("Geographic coordinates:  {0}" & vbCrLf, resultInfo.Location))
        resultList.Append(String.Format("______________________________" & vbCrLf))
        resCounter += 1
    Next resultInfo
    MessageBox.Show(resultList.ToString())
End Sub
Dim informationLayer As New InformationLayer()
informationLayer.DataProvider = azureSearchProvider
map.Layers.Add(informationLayer)

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SearchCompleted 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.

C#

winforms-map-execute-the-search-operation-for-multiple-locations/CS/GetSearchLocationAdditionalInfo/Form1.cs#L19

    PrepareMap();
    searchProvider.SearchCompleted += SearchProvider_SearchCompleted;
}

VB.NET

winforms-map-execute-the-search-operation-for-multiple-locations/VB/GetSearchLocationAdditionalInfo/Form1.vb#L23

    AddHandler Me.searchProvider.SearchCompleted, AddressOf SearchProvider_SearchCompleted
End Sub