Xamarin.Forms by Microsoft

<PackageReference Include="Xamarin.Forms" Version="4.2.0.709249" />

.NET API 1,136,240 bytes

 SearchHandler

Default implementation of ISearchHandlerController.

The backing store for the ClearIconHelpText field.

public static readonly BindableProperty ClearIconNameProperty

The backing store for the ClearIconName field.

public static readonly BindableProperty ClearIconProperty

The backing store for the ClearIcon field.

The backing store for the ClearPlaceholderCommandParameter field.

The backing store for the ClearPlaceholderCommand field.

The backing store for the ClearPlaceholderEnabled field.

The backing store for the ClearPlaceholderHelpText field.

The backing store for the ClearPlaceholderIcon field.

The backing store for the ClearPlaceholderName field.

The backing store for the CommandParameter field.

public static readonly BindableProperty CommandProperty

The backing store for the Command field.

The backing store for the DisplayMemberName field.

public static readonly BindableProperty FontFamilyProperty

public static readonly BindableProperty FontSizeProperty

public static readonly BindableProperty IsFocusedProperty

The backing store for the IsSearchEnabled field.

public static readonly BindableProperty ItemsSourceProperty

The backing store for the ItemsSource field.

public static readonly BindableProperty ItemTemplateProperty

The backing store for the ItemTemplate field.

public static readonly BindableProperty KeyboardProperty

public static readonly BindableProperty PlaceholderProperty

The backing store for the Placeholder field.

The backing store for the QueryIconHelpText field.

public static readonly BindableProperty QueryIconNameProperty

The backing store for the QueryIconName field.

public static readonly BindableProperty QueryIconProperty

The backing store for the QueryIcon field.

public static readonly BindableProperty QueryProperty

The backing store for the Query field.

The backing store for the SearchBoxVisibility field.

The backing store for the SelectedItem field.

public static readonly BindableProperty ShowsResultsProperty

The backing store for the ShowsResults field.

public static readonly BindableProperty TextColorProperty

public Color BackgroundColor { get; set; }

public Color CancelButtonColor { get; set; }

public ImageSource ClearIcon { get; set; }

The icon displayed to clear the contents of the search box.

public string ClearIconHelpText { get; set; }

The accessible help text for the clear icon.

public string ClearIconName { get; set; }

The name of the clear icon for use with screen readers.

public ICommand ClearPlaceholderCommand { get; set; }

ICommand executed when the ClearPlaceholderIcon is tapped.

public object ClearPlaceholderCommandParameter { get; set; }

The parameter passed to the ClearPlaceholderCommand.

public bool ClearPlaceholderEnabled { get; set; }

Whether the ClearPlaceholderCommand can be executed.

public string ClearPlaceholderHelpText { get; set; }

The accessible help text for the ClearPlaceholderIcon.

public ImageSource ClearPlaceholderIcon { get; set; }

The clear placeholder icon displayed when the search box is empty.

public string ClearPlaceholderName { get; set; }

The name of the clear placeholder icon for use with screen readers.

public ICommand Command { get; set; }

Gets or sets the ICommand executed when the search query is confirmed.

public object CommandParameter { get; set; }

Gets or sets the parameter of the Command, which is executed when the search query is confirmed.

public string DisplayMemberName { get; set; }

The name or path of the property that is displayed for each item of data in the ItemsSource collection.

public FontAttributes FontAttributes { get; set; }

public string FontFamily { get; set; }

public double FontSize { get; set; }

public bool IsFocused { get; }

public bool IsSearchEnabled { get; set; }

Gets or sets whether the search box is enabled.

public IEnumerable ItemsSource { get; set; }

The collection of items to be displayed in the suggestion area. Default is null.

public DataTemplate ItemTemplate { get; set; }

The DataTemplate to apply to each item in ItemsSource.

public Keyboard Keyboard { get; set; }

public string Placeholder { get; set; }

The text to display when the search box is empty.

public Color PlaceholderColor { get; set; }

public string Query { get; set; }

Gets or sets the text of the search box.

public ImageSource QueryIcon { get; set; }

The icon used to indicate that search is available.

public string QueryIconHelpText { get; set; }

The accessible help text for the QueryIcon.

public string QueryIconName { get; set; }

The name of the QueryIcon for use with screen readers.

Gets or sets whether the search box is visible.

public object SelectedItem { get; }

public bool ShowsResults { get; set; }

Gets or sets whether search results should be expected in the suggestion area on text entry.

public Color TextColor { get; set; }

public SearchHandler()

public bool Focus()

protected virtual void OnClearPlaceholderClicked()

Developers may override this method to respond to the ClearPlaceholderIcon being tapped.

protected virtual void OnFocused()

protected virtual void OnItemSelected(object item)

Developers may override this method to respond to a search result being selected by the user.

protected virtual void OnQueryChanged(string oldValue, string newValue)

Developers may override this method to respond to the Query being modified.

protected virtual void OnQueryConfirmed()

Developers may override this method to respond to the user entering or confirming their query in the search box.

protected virtual void OnUnfocus()

public void SetIsFocused(bool value)

public void Unfocus()