Back to Devexpress

MapSearchPanelOptions.NullValuePrompt Property

windowsforms-devexpress-dot-xtramap-dot-mapsearchpaneloptions-58846f6d.md

latest3.5 KB
Original Source

MapSearchPanelOptions.NullValuePrompt Property

Gets or sets the text displayed in the search panel when no search requests are entered.

Namespace : DevExpress.XtraMap

Assembly : DevExpress.XtraMap.v25.2.dll

NuGet Package : DevExpress.Win.Map

Declaration

csharp
[DefaultValue("")]
public string NullValuePrompt { get; set; }
vb
<DefaultValue("")>
Public Property NullValuePrompt As String

Property Value

TypeDefaultDescription
StringString.Empty

The prompt text.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to NullValuePrompt
MapControl

.SearchPanelOptions .NullValuePrompt

|

Remarks

Use the ShowNullValuePrompt property to specify whether the search panel shows the prompt.

Example

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

csharp
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
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

See Also

MapSearchPanelOptions Class

MapSearchPanelOptions Members

DevExpress.XtraMap Namespace