MapSearchPanelOptions.ShowNullValuePrompt Property

Gets or sets whether to show a prompt when no request is typed in the search panel.

Namespace: DevExpress.XtraMap

Assembly: DevExpress.XtraMap.v23.2.dll

NuGet Package: DevExpress.Win.Map

Declaration

C#

[DefaultValue(true)]
public bool ShowNullValuePrompt { get; set; }

VB.NET

<DefaultValue(True)>
Public Property ShowNullValuePrompt As Boolean

Property Value

Type	Default	Description
Boolean	true	true if the prompt is shown; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to ShowNullValuePrompt
MapControl	.SearchPanelOptions .ShowNullValuePrompt

Remarks

Use the NullValuePrompt property to define the prompt text.

Example

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

C#

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;
    }

VB.NET

Imports DevExpress.XtraMap
    Private Sub OnFormLoad(ByVal sender As Object, ByVal e As EventArgs)
        ' Enable search:
        Dim infoLayer As InformationLayer = New InformationLayer()
        mapControl1.Layers.Add(infoLayer)
        Dim searchProvider As BingSearchDataProvider = 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
    End Sub