SearchHandler Class

Reference

Definition

Namespace:: Xamarin.Forms

Assembly:: Xamarin.Forms.Core.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Default implementation of ISearchHandlerController.

public class SearchHandler : Xamarin.Forms.BindableObject, Xamarin.Forms.Internals.IFontElement, Xamarin.Forms.ISearchHandlerController

type SearchHandler = class
    inherit BindableObject
    interface ISearchHandlerController
    interface IFontElement

Inheritance: Object

BindableObject
SearchHandler

Implements: IFontElement ISearchHandlerController

Constructors

SearchHandler()

Fields

BackgroundColorProperty
CancelButtonColorProperty
CharacterSpacingProperty
ClearIconHelpTextProperty	The backing store for the ClearIconHelpText field.
ClearIconNameProperty	The backing store for the ClearIconName field.
ClearIconProperty	The backing store for the ClearIcon field.
ClearPlaceholderCommandParameterProperty	The backing store for the ClearPlaceholderCommandParameter field.
ClearPlaceholderCommandProperty	The backing store for the ClearPlaceholderCommand field.
ClearPlaceholderEnabledProperty	The backing store for the ClearPlaceholderEnabled field.
ClearPlaceholderHelpTextProperty	The backing store for the ClearPlaceholderHelpText field.
ClearPlaceholderIconProperty	The backing store for the ClearPlaceholderIcon field.
ClearPlaceholderNameProperty	The backing store for the ClearPlaceholderName field.
CommandParameterProperty	The backing store for the CommandParameter field.
CommandProperty	The backing store for the Command field.
DisplayMemberNameProperty	The backing store for the DisplayMemberName field.
FontAttributesProperty
FontFamilyProperty
FontSizeProperty
HorizontalTextAlignmentProperty
IsFocusedProperty
IsFocusedPropertyKey
IsSearchEnabledProperty	The backing store for the IsSearchEnabled field.
ItemsSourceProperty	The backing store for the ItemsSource field.
ItemTemplateProperty	The backing store for the ItemTemplate field.
KeyboardProperty
PlaceholderColorProperty
PlaceholderProperty	The backing store for the Placeholder field.
QueryIconHelpTextProperty	The backing store for the QueryIconHelpText field.
QueryIconNameProperty	The backing store for the QueryIconName field.
QueryIconProperty	The backing store for the QueryIcon field.
QueryProperty	The backing store for the Query field.
SearchBoxVisibilityProperty	The backing store for the SearchBoxVisibility field.
SelectedItemProperty	The backing store for the SelectedItem field.
ShowsResultsProperty	The backing store for the ShowsResults field.
TextColorProperty
TextTransformProperty
VerticalTextAlignmentProperty

Properties

BackgroundColor
BindingContext	Gets or sets object that contains the properties that will be targeted by the bound properties that belong to this BindableObject. (Inherited from BindableObject)
CancelButtonColor
CharacterSpacing
ClearIcon	The icon displayed to clear the contents of the search box.
ClearIconHelpText	The accessible help text for the clear icon.
ClearIconName	The name of the clear icon for use with screen readers.
ClearPlaceholderCommand	ICommand executed when the ClearPlaceholderIcon is tapped.
ClearPlaceholderCommandParameter	The parameter passed to the ClearPlaceholderCommand.
ClearPlaceholderEnabled	Whether the ClearPlaceholderCommand can be executed.
ClearPlaceholderHelpText	The accessible help text for the ClearPlaceholderIcon.
ClearPlaceholderIcon	The clear placeholder icon displayed when the search box is empty.
ClearPlaceholderName	The name of the clear placeholder icon for use with screen readers.
Command	Gets or sets the ICommand executed when the search query is confirmed.
CommandParameter	Gets or sets the parameter of the Command, which is executed when the search query is confirmed.
Dispatcher	(Inherited from BindableObject)
DisplayMemberName	The name or path of the property that is displayed for each item of data in the ItemsSource collection.
FontAttributes
FontFamily
FontSize
HorizontalTextAlignment
IsFocused
IsSearchEnabled	Gets or sets whether the search box is enabled.
ItemsSource	The collection of items to be displayed in the suggestion area. Default is `null`.
ItemTemplate	The DataTemplate to apply to each item in ItemsSource.
Keyboard
Placeholder	The text to display when the search box is empty.
PlaceholderColor
Query	Gets or sets the text of the search box.
QueryIcon	The icon used to indicate that search is available.
QueryIconHelpText	The accessible help text for the QueryIcon.
QueryIconName	The name of the QueryIcon for use with screen readers.
SearchBoxVisibility	Gets or sets whether the search box is visible.
SelectedItem
ShowsResults	Gets or sets whether search results should be expected in the suggestion area on text entry.
TextColor
TextTransform
VerticalTextAlignment

Methods

ApplyBindings()	Apply the bindings to BindingContext. (Inherited from BindableObject)
ClearValue(BindableProperty)	Clears any value set by SetValue for `property`. (Inherited from BindableObject)
ClearValue(BindablePropertyKey)	Clears any value set by SetValue for the property that is identified by `propertyKey`. (Inherited from BindableObject)
CoerceValue(BindableProperty)	(Inherited from BindableObject)
CoerceValue(BindablePropertyKey)	(Inherited from BindableObject)
Focus()
GetValue(BindableProperty)	Returns the value that is contained in the BindableProperty. (Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty)	Obsolete. For internal use by the Xamarin.Forms platform. (Inherited from BindableObject)
GetValues(BindableProperty, BindableProperty, BindableProperty)	Obsolete. For internal use by the Xamarin.Forms platform. (Inherited from BindableObject)
IsSet(BindableProperty)	Returns `true` if the target property exists and has been set. (Inherited from BindableObject)
OnBindingContextChanged()	Override this method to execute an action when the BindingContext changes. (Inherited from BindableObject)
OnClearPlaceholderClicked()	Developers may override this method to respond to the ClearPlaceholderIcon being tapped.
OnFocused()
OnItemSelected(Object)	Developers may override this method to respond to a search result being selected by the user.
OnPropertyChanged(String)	Call this method from a child class to notify that a change happened on a property. (Inherited from BindableObject)
OnPropertyChanging(String)	Call this method from a child class to notify that a change is going to happen on a property. (Inherited from BindableObject)
OnQueryChanged(String, String)	Developers may override this method to respond to the Query being modified.
OnQueryConfirmed()	Developers may override this method to respond to the user entering or confirming their query in the search box.
OnUnfocus()
RemoveBinding(BindableProperty)	Removes a previously set binding. (Inherited from BindableObject)
SetBinding(BindableProperty, BindingBase)	Assigns a binding to a property. (Inherited from BindableObject)
SetIsFocused(Boolean)
SetValue(BindableProperty, Object)	Sets the value of the specified property. (Inherited from BindableObject)
SetValue(BindablePropertyKey, Object)	Sets the value of the propertyKey. (Inherited from BindableObject)
SetValueCore(BindableProperty, Object, SetValueFlags)	For internal use by the Xamarin.Forms platform. (Inherited from BindableObject)
UnapplyBindings()	Unapplies all previously set bindings. (Inherited from BindableObject)
Unfocus()
UpdateFormsText(String, TextTransform)

Events

BindingContextChanged	Raised whenever the BindingContext property changes. (Inherited from BindableObject)
FocusChangeRequested
Focused
PropertyChanged	Raised when a property has changed. (Inherited from BindableObject)
PropertyChanging	Raised when a property is about to change. (Inherited from BindableObject)
Unfocused

Explicit Interface Implementations

IDynamicResourceHandler.SetDynamicResource(BindableProperty, String)	For internal use by the Xamarin.Forms platform. (Inherited from BindableObject)
IFontElement.FontSizeDefaultValueCreator()
IFontElement.OnFontAttributesChanged(FontAttributes, FontAttributes)
IFontElement.OnFontChanged(Font, Font)
IFontElement.OnFontFamilyChanged(String, String)
IFontElement.OnFontSizeChanged(Double, Double)
ISearchHandlerController.ClearPlaceholderClicked()
ISearchHandlerController.ItemSelected(Object)
ISearchHandlerController.ListProxy
ISearchHandlerController.ListProxyChanged
ISearchHandlerController.QueryConfirmed()

Extension Methods

GetPropertyIfSet<T>(BindableObject, BindableProperty, T)
SetAppThemeColor(BindableObject, BindableProperty, Color, Color)
SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String)	Creates and applies a binding to a property.
SetBinding<TSource>(BindableObject, BindableProperty, Expression<Func<TSource,Object>>, BindingMode, IValueConverter, String)	Obsolete. Creates and applies a binding from an expression.
SetOnAppTheme<T>(BindableObject, BindableProperty, T, T)

Applies to