Class SearchView

View for searching with locators or custom search sources.

Inheritance

Object

SearchView

Namespace: Esri.ArcGISRuntime.Toolkit.UI.Controls

Assembly: Esri.ArcGISRuntime.Toolkit.WinUI.dll

Syntax

public class SearchView : Control

Constructors

SearchView()

Initializes a new instance of the SearchView class.

Declaration

public SearchView()

Fields

AllSourceSelectTextProperty

Identifies the AllSourceSelectText dependency property.

Declaration

public static readonly DependencyProperty AllSourceSelectTextProperty

Field Value

Type	Description
DependencyProperty

ClearSearchTooltipTextProperty

Identifies the ClearSearchTooltipText dependency property.

Declaration

public static readonly DependencyProperty ClearSearchTooltipTextProperty

Field Value

Type	Description
DependencyProperty

EnableDefaultWorldGeocoderProperty

Identifies the EnableDefaultWorldGeocoder dependency property.

Declaration

public static readonly DependencyProperty EnableDefaultWorldGeocoderProperty

Field Value

Type	Description
DependencyProperty

EnableIndividualResultDisplayProperty

Identifies the EnableIndividualResultDisplay dependency property.

Declaration

public static readonly DependencyProperty EnableIndividualResultDisplayProperty

Field Value

Type	Description
DependencyProperty

EnableRepeatSearchHereButtonProperty

Identifies the EnableRepeatSearchHereButton dependency proeprty.

Declaration

public static readonly DependencyProperty EnableRepeatSearchHereButtonProperty

Field Value

Type	Description
DependencyProperty

EnableResultListViewProperty

Identifies the EnableResultListView dependency property.

Declaration

public static readonly DependencyProperty EnableResultListViewProperty

Field Value

Type	Description
DependencyProperty

GeoViewProperty

Identifies the GeoView dependency property.

Declaration

public static readonly DependencyProperty GeoViewProperty

Field Value

Type	Description
DependencyProperty

IsSourceSelectOpenProperty

Identifies the IsSourceSelectOpen dependency property.

Declaration

public static readonly DependencyProperty IsSourceSelectOpenProperty

Field Value

Type	Description
DependencyProperty

MultipleResultZoomBufferProperty

Identifies the MultipleResultZoomBuffer dependency property.

Declaration

public static readonly DependencyProperty MultipleResultZoomBufferProperty

Field Value

Type	Description
DependencyProperty

NoResultMessageProperty

Identifies the NoResultMessage dependency property.

Declaration

public static readonly DependencyProperty NoResultMessageProperty

Field Value

Type	Description
DependencyProperty

RepeatSearchButtonTextProperty

Identifies the RepeatSearchButtonText dependency property.

Declaration

public static readonly DependencyProperty RepeatSearchButtonTextProperty

Field Value

Type	Description
DependencyProperty

SearchTooltipTextProperty

Identifies the SearchTooltipText dependency property.

Declaration

public static readonly DependencyProperty SearchTooltipTextProperty

Field Value

Type	Description
DependencyProperty

SearchViewModelProperty

Identifies the SearchViewModel dependency property.

Declaration

public static readonly DependencyProperty SearchViewModelProperty

Field Value

Type	Description
DependencyProperty

Properties

AllSourceSelectText

Gets or sets the text to display for the button used to select all search sources.

Declaration

public string AllSourceSelectText { get; set; }

Property Value

Type	Description
String

ClearSearchTooltipText

Gets or sets the tooltip text to display for the clear/cancel search button.

Declaration

public string ClearSearchTooltipText { get; set; }

Property Value

Type	Description
String

EnableDefaultWorldGeocoder

Gets or sets a value indicating whether SearchViewModel will include the Esri World Geocoder service by default.

Declaration

public bool EnableDefaultWorldGeocoder { get; set; }

Property Value

Type	Description
Boolean

EnableIndividualResultDisplay

Gets or sets a value indicating whether the view will show the selected result. If false, the result list is hidden automatically when a result is selected.

Declaration

public bool EnableIndividualResultDisplay { get; set; }

Property Value

Type	Description
Boolean

Remarks

See SelectedResult to display custom UI for the selected result.

EnableRepeatSearchHereButton

Gets or sets a value indicating whether a 'Repeat Search' button will be displayed when the user pans the map a sufficient amount after a search completes.

Declaration

public bool EnableRepeatSearchHereButton { get; set; }

Property Value

Type	Description
Boolean

Remarks

Some consumer applications will display this button in a separate area of the UI from the search bar, often centered over the map. This property is intended to allow hiding the default button if using a custom 'Repeat Search' implementation. See and IsEligibleForRequery to enable a custom button implementation.

EnableResultListView

Gets or sets a value indicating whether the default result list view will be shown.

Declaration

public bool EnableResultListView { get; set; }

Property Value

Type	Description
Boolean

Remarks

Set this value to false to enable a custom list presentation.

GeoView

Gets or sets the GeoView associated with this view.

Declaration

public GeoView? GeoView { get; set; }

Property Value

Type	Description
Nullable<GeoView>

Remarks

If set, SearchView will add a graphics overlay for showing results, and will automatically navigate to show search results.

GroupedSuggestions

Gets the grouped list of suggestions.

Declaration

public List<SearchView.SuggestionsGrouped>? GroupedSuggestions { get; }

Property Value

Type	Description
Nullable<List<SearchView.SuggestionsGrouped>>

IsSourceSelectOpen

Gets or sets a value indicating whether the source selection view is being displayed.

Declaration

public bool IsSourceSelectOpen { get; set; }

Property Value

Type	Description
Boolean

MultipleResultZoomBuffer

Gets or sets the buffer used when zooming to a set of results.

Declaration

public double MultipleResultZoomBuffer { get; set; }

Property Value

Type	Description
Double

NoResultMessage

Gets or sets a message to show when a search completes with no results.

Declaration

public string NoResultMessage { get; set; }

Property Value

Type	Description
String

RepeatSearchButtonText

Gets or sets the text to display in the 'Repeat Search' button.

Declaration

public string RepeatSearchButtonText { get; set; }

Property Value

Type	Description
String

SearchTooltipText

Gets or sets the tooltip text to display for the search button.

Declaration

public string SearchTooltipText { get; set; }

Property Value

Type	Description
String

SearchViewModel

Gets or sets the viewmodel that implements core search behavior.

Declaration

public SearchViewModel SearchViewModel { get; set; }

Property Value

Type	Description
SearchViewModel

SelectedSuggestion

Gets or sets the selected suggestion, triggering a search.

Declaration

public SearchSuggestion SelectedSuggestion { get; set; }

Property Value

Type	Description
SearchSuggestion

TemplateSettings

SearchViewTemplateSettings provides a set of properties that are used when you define a new control template for a control that derives from SearchView.

Declaration

public SearchViewTemplateSettings TemplateSettings { get; }

Property Value

Type	Description
SearchViewTemplateSettings

Methods

OnApplyTemplate()

Declaration

protected override void OnApplyTemplate()