BingSearchOptions Class

Contains settings that define the parameters for searching via the Microsoft Bing service.

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

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

Declaration

C#
VB.NET

public class BingSearchOptions :
    MapDependencyObject

Public Class BingSearchOptions
    Inherits MapDependencyObject

The following members return BingSearchOptions objects:

Remarks

Bing Search options are represented by the BingSearchOptions object that can be accessed via the BingSearchDataProvider.SearchOptions property.

Then, you can specify the search radius (BingSearchOptions.SearchRadius), the displayed number of search results (BingSearchOptions.ResultsCount) and other search parameters.

Example

This example demonstrates how to allow users to search for a specific place on a map using the Search panel.

To enable searching in the map control, do the following.

Create an InformationLayer and add it to the MapControl.Layers collection.
Create an instance of the BingSearchDataProvider and assign it to the InformationLayer.DataProvider property.
Specify the Bing Maps key using the BingMapDataProviderBase.BingKey property.

The Search panel appears automatically (since the BingSearchDataProvider.ShowSearchPanel property value is true by default).

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:InformationLayer.DataProvider>
    <dxm:BingSearchDataProvider BingKey="{Binding Source={StaticResource YourBingKey}}">
        <dxm:BingSearchDataProvider.SearchOptions>
            <dxm:BingSearchOptions ResultsCount="5" />
        </dxm:BingSearchDataProvider.SearchOptions>
    </dxm:BingSearchDataProvider>
</dxm:InformationLayer.DataProvider>

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

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-manually-process-search-using-a-custom-search-panel-t189413/CS/MapControl_SearchPanel/MainWindow.xaml#L40

<dxm:BingSearchDataProvider.SearchOptions>
    <dxm:BingSearchOptions x:Name="options"
                           AutocorrectQuery="{Binding ElementName=cbAutocorrect, Path=IsChecked}"