Skip to main content
All docs
V25.1
  • DevExpress v25.1 Update — Your Feedback Matters

    Our What's New in v25.1 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

    Take the survey Not interested

    MapSearchPanelOptions Class

    Contains map search panel settings.

    Namespace: DevExpress.XtraMap

    Assembly: DevExpress.XtraMap.v25.1.dll

    NuGet Package: DevExpress.Win.Map

    #Declaration

    public class MapSearchPanelOptions :
        INotifyPropertyChanged

    The following members return MapSearchPanelOptions objects:

    #Remarks

    The map control shows the search panel if you assign a search provider to an information layer. For more information, refer to the following topic: Search.

    You can use the MapControl.SearchPanelOptions property to customize the search panel. This property returns a MapSearchPanelOptions object that stores individual options. The list below describes key settings:

    • Visible – Controls search panel visibility.
    • NullValuePrompt – Specifies the prompt message text. The search panel shows this message when no search request is entered. If NullValuePrompt is not specified, the map control shows the default text. You can also disable the ShowNullValuePrompt property to hide the message.
    • MaxVisibleItemCount – Sets the number of visible search results in the search panel drop-down list.
    • Width – Specifies the search panel width in DIPs (device-independent pixels).

    The following example configures the search panel options such as width, prompt message, and so on:

    Map search panel customization

    using DevExpress.XtraMap;
    
        private void OnFormLoad(object sender, EventArgs e) {
            // Enable search:
            InformationLayer infoLayer = new InformationLayer();
            mapControl1.Layers.Add(infoLayer);
            BingSearchDataProvider searchProvider = new BingSearchDataProvider();
            infoLayer.DataProvider = searchProvider;
            searchProvider.BingKey = bingKey;
    
            // Specify search panel options:
            mapControl1.SearchPanelOptions.Visible = true;
            mapControl1.SearchPanelOptions.ShowNullValuePrompt = true;
            mapControl1.SearchPanelOptions.NullValuePrompt = "Type a location to search...";
            mapControl1.SearchPanelOptions.MaxVisibleItemCount = 3;
            mapControl1.SearchPanelOptions.Width = 200;
        }
    

    #Inheritance

    Object
    MapSearchPanelOptions
    See Also