BingSearchDataProvider.Search(String) Method

Searches for locations that best correspond to the specified keywords.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v19.2.dll

Declaration

C#

public void Search(
    string keyword
)

VB.NET

Public Sub Search(
    keyword As String
)

Parameters

Name	Type	Description
keyword	String	A String containing information to search on a map. This string can contain either geographical names or any other information to look for.

Example

To manually generate map items for received GIS data, do the following.

• Set the InformationDataProviderBase.GenerateLayerItems property to false.
• Handle the Geocode data received event of the Bing geocode data provider (BingSearchDataProvider.SearchCompleted).
• In the event handler, implement map item generation based on information stored in the SearchRequestResult.SearchResults array of LocationInformation objects.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/manually-generate-map-items-for-location-information-received-from-the-bing-search-provider-t188838

Form1.cs

using DevExpress.XtraEditors;
using DevExpress.XtraMap;
using System;
using System.Text;

namespace MapControl_SearchProcessing {
    public partial class Form1 : XtraForm {

        string BingKey { get { return "YourBingKey"; } }

        public Form1() {
            InitializeComponent();
            SearchProvider.SearchCompleted += OnSearchCompleted;
            SearchLayer.DataRequestCompleted += OnDataRequestCompleted;
            BingMapDataProvider.BingKey = BingKey;
            SearchProvider.BingKey = BingKey;
        }

        private void btnSearch_Click(object sender, EventArgs e) {
            SearchProvider.Search(teKeyword.Text);
        }

        #region #SearchResultProcessing
        void OnSearchCompleted(object sender, BingSearchCompletedEventArgs e) {
            if(e.Cancelled) return;
            if(e.RequestResult.ResultCode != RequestResultCode.Success) {
                meResult.Text = "The Bing Search service does not work for this location.";
                return;
            }

            StringBuilder resultList = new StringBuilder("");
            int resCounter = 1;
            foreach(BingLocationInformation resultInfo in e.RequestResult.SearchResults) {
                resultList.Append(String.Format("Result {0}:  \r\n", resCounter));
                resultList.Append(String.Format("Name: {0}\r\n", resultInfo.DisplayName));              
                resultList.Append(String.Format("Address: {0}\r\n", resultInfo.Address.FormattedAddress));
                resultList.Append(String.Format("Confidence level: {0}\r\n", resultInfo.Confidence));
                resultList.Append(String.Format("Geographic coordinates:  {0}\r\n", resultInfo.Location));
                resultList.Append(String.Format("Match code: {0}\r\n", resultInfo.MatchCode));
                resultList.Append(String.Format("______________________________\r\n"));
                resCounter++;
            }
            meResult.Text = resultList.ToString();
        }
        #endregion #SearchResultProcessing

        void OnDataRequestCompleted(object sender, RequestCompletedEventArgs e) {
            mapControl.ZoomToFitLayerItems(0.4);
        }
    }
}

Program.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace MapControl_SearchProcessing {
    static class Program {
        /// <summary>
        /// The main entry point for the application.
        /// </summary>
        [STAThread]
        static void Main() {
            Application.EnableVisualStyles();
            Application.SetCompatibleTextRenderingDefault(false);
            Application.Run(new Form1());
        }
    }
}

Form1.vb

Imports DevExpress.XtraEditors
Imports DevExpress.XtraMap
Imports System
Imports System.Text

Namespace MapControl_SearchProcessing
    Partial Public Class Form1
        Inherits XtraForm

        Private ReadOnly Property BingKey() As String
            Get
                Return "YourBingKey"
            End Get
        End Property

        Public Sub New()
            InitializeComponent()
            AddHandler SearchProvider.SearchCompleted, AddressOf OnSearchCompleted
            AddHandler SearchLayer.DataRequestCompleted, AddressOf OnDataRequestCompleted
            BingMapDataProvider.BingKey = BingKey
            SearchProvider.BingKey = BingKey
        End Sub

        Private Sub btnSearch_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnSearch.Click
            SearchProvider.Search(teKeyword.Text)
        End Sub

        #Region "#SearchResultProcessing"
        Private Sub OnSearchCompleted(ByVal sender As Object, ByVal e As BingSearchCompletedEventArgs)
            If e.Cancelled Then
                Return
            End If
            If e.RequestResult.ResultCode <> RequestResultCode.Success Then
                meResult.Text = "The Bing 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 BingLocationInformation In e.RequestResult.SearchResults
                resultList.Append(String.Format("Result {0}:  " & ControlChars.CrLf, resCounter))
                resultList.Append(String.Format("Name: {0}" & ControlChars.CrLf, resultInfo.DisplayName))
                resultList.Append(String.Format("Address: {0}" & ControlChars.CrLf, resultInfo.Address.FormattedAddress))
                resultList.Append(String.Format("Confidence level: {0}" & ControlChars.CrLf, resultInfo.Confidence))
                resultList.Append(String.Format("Geographic coordinates:  {0}" & ControlChars.CrLf, resultInfo.Location))
                resultList.Append(String.Format("Match code: {0}" & ControlChars.CrLf, resultInfo.MatchCode))
                resultList.Append(String.Format("______________________________" & ControlChars.CrLf))
                resCounter += 1
            Next resultInfo
            meResult.Text = resultList.ToString()
        End Sub
        #End Region ' #SearchResultProcessing

        Private Sub OnDataRequestCompleted(ByVal sender As Object, ByVal e As RequestCompletedEventArgs)
            mapControl.ZoomToFitLayerItems(0.4)
        End Sub
    End Class
End Namespace

Program.vb

Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Threading.Tasks
Imports System.Windows.Forms

Namespace MapControl_SearchProcessing
    Friend NotInheritable Class Program

        Private Sub New()
        End Sub

        ''' <summary>
        ''' The main entry point for the application.
        ''' </summary>
        <STAThread> _
        Shared Sub Main()
            Application.EnableVisualStyles()
            Application.SetCompatibleTextRenderingDefault(False)
            Application.Run(New Form1())
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Search(String) 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-create-a-custom-search-panel-e5084/CS/MapControl_SearchPanel/Form1.cs#L20

private void bSearch_Click(object sender, EventArgs e) {
    SearchProvider.Search(teKeyword.Text);
}

how-to-get-additional-search-results-using-the-bing-map-search-service-e5066/CS/GetSearchLocationAdditionalInfo/Form1.cs#L25

    // Call the Search method.
    searchProvider.Search(tbLocation.Text);
}

manually-generate-map-items-for-location-information-received-from-the-bing-search-provider-t188838/CS/MapControl_SearchProcessing/Form1.cs#L20

private void btnSearch_Click(object sender, EventArgs e) {
    SearchProvider.Search(teKeyword.Text);
}

how-to-perform-the-search-operation-for-multiple-locations-t546604/CS/GetSearchLocationAdditionalInfo/Form1.cs#L42

    if (idx < addresses.Count)
    searchProvider.Search(addresses[idx++]);
}

VB.NET

how-to-create-a-custom-search-panel-e5084/VB/MapControl_SearchPanel/Form1.vb#L30

Private Sub bSearch_Click(ByVal sender As Object, ByVal e As EventArgs) Handles bSearch.Click
    SearchProvider.Search(teKeyword.Text)
End Sub

how-to-get-additional-search-results-using-the-bing-map-search-service-e5066/VB/GetSearchLocationAdditionalInfo/Form1.vb#L25

    ' Call the Search method.
    searchProvider.Search(tbLocation.Text)
End Sub

manually-generate-map-items-for-location-information-received-from-the-bing-search-provider-t188838/VB/MapControl_SearchProcessing/Form1.vb#L26

Private Sub btnSearch_Click(ByVal sender As Object, ByVal e As EventArgs)
    SearchProvider.Search(teKeyword.Text)
End Sub

how-to-perform-the-search-operation-for-multiple-locations-t546604/VB/GetSearchLocationAdditionalInfo/Form1.vb#L39

If idx < addresses.Count Then
searchProvider.Search(addresses(idx))
idx += 1