Share via


SearchHandler Class

Definition

Default implementation of ISearchHandlerController.

public ref class SearchHandler : Microsoft::Maui::Controls::BindableObject, Microsoft::Maui::Controls::Internals::IFontElement, Microsoft::Maui::Controls::ISearchHandlerController
public class SearchHandler : Microsoft.Maui.Controls.BindableObject, Microsoft.Maui.Controls.Internals.IFontElement, Microsoft.Maui.Controls.ISearchHandlerController
type SearchHandler = class
    inherit BindableObject
    interface ISearchHandlerController
    interface IFontElement
Public Class SearchHandler
Inherits BindableObject
Implements IFontElement, ISearchHandlerController
Inheritance
SearchHandler
Implements

Constructors

SearchHandler()

Fields

AutomationIdProperty

Bindable property for AutomationId.

BackgroundColorProperty

Bindable property for BackgroundColor.

CancelButtonColorProperty

Bindable property for CancelButtonColor.

CharacterSpacingProperty

Bindable property for CharacterSpacing.

ClearIconHelpTextProperty

Bindable property for ClearIconHelpText.

ClearIconNameProperty

Bindable property for ClearIconName.

ClearIconProperty

Bindable property for ClearIcon.

ClearPlaceholderCommandParameterProperty

Bindable property for ClearPlaceholderCommandParameter.

ClearPlaceholderCommandProperty

Bindable property for ClearPlaceholderCommand.

ClearPlaceholderEnabledProperty

Bindable property for ClearPlaceholderEnabled.

ClearPlaceholderHelpTextProperty

Bindable property for ClearPlaceholderHelpText.

ClearPlaceholderIconProperty

Bindable property for ClearPlaceholderIcon.

ClearPlaceholderNameProperty

Bindable property for ClearPlaceholderName.

CommandParameterProperty

Bindable property for CommandParameter.

CommandProperty

Bindable property for Command.

DisplayMemberNameProperty

Bindable property for DisplayMemberName.

FontAttributesProperty

Bindable property for FontAttributes.

FontAutoScalingEnabledProperty

Bindable property for FontAutoScalingEnabled.

FontFamilyProperty

Bindable property for FontFamily.

FontSizeProperty

Bindable property for FontSize.

HorizontalTextAlignmentProperty

Bindable property for HorizontalTextAlignment.

IsFocusedProperty

Bindable property for IsFocused.

IsFocusedPropertyKey
IsSearchEnabledProperty

Bindable property for IsSearchEnabled.

ItemsSourceProperty

Bindable property for ItemsSource.

ItemTemplateProperty

Bindable property for ItemTemplate.

KeyboardProperty

Bindable property for Keyboard.

PlaceholderColorProperty

Bindable property for PlaceholderColor.

PlaceholderProperty

Bindable property for Placeholder.

QueryIconHelpTextProperty

Bindable property for QueryIconHelpText.

QueryIconNameProperty

Bindable property for QueryIconName.

QueryIconProperty

Bindable property for QueryIcon.

QueryProperty

Bindable property for Query.

SearchBoxVisibilityProperty

Bindable property for SearchBoxVisibility.

SelectedItemProperty

The backing store for the SelectedItem field.

ShowsResultsProperty

Bindable property for ShowsResults.

TextColorProperty

Bindable property for TextColor.

TextTransformProperty

Bindable property for TextTransform.

VerticalTextAlignmentProperty

Bindable property for VerticalTextAlignment.

Properties

AutomationId
BackgroundColor
BindingContext

Gets or sets an object that contains the properties that will be targeted by the bound properties that belong to this BindableObject. This is a bindable property.

(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

Gets the dispatcher that was available when this bindable object was created, otherwise tries to find the nearest available dispatcher (probably the window's/app's).

(Inherited from BindableObject)
DisplayMemberName
Obsolete.

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

FontAttributes
FontAutoScalingEnabled
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()

Applies all the current bindings to BindingContext.

(Inherited from BindableObject)
ClearValue(BindableProperty)

Clears any value that is previously set for a bindable property.

(Inherited from BindableObject)
ClearValue(BindablePropertyKey)

Clears any value that is previously set for a bindable property, identified by its key.

(Inherited from BindableObject)
CoerceValue(BindableProperty)

Coerces the value of the specified bindable property. This is done by invoking BindableProperty.CoerceValueDelegate of the specified bindable property.

(Inherited from BindableObject)
CoerceValue(BindablePropertyKey)

Coerces the value of the specified bindable property. This is done by invoking BindableProperty.CoerceValueDelegate of the specified bindable property.

(Inherited from BindableObject)
Focus()
GetValue(BindableProperty)

Returns the value that is contained in the given bindable property.

(Inherited from BindableObject)
IsSet(BindableProperty)

Determines whether or not a bindable property exists and has a value set.

(Inherited from BindableObject)
OnBindingContextChanged()

Raises the BindingContextChanged event.

(Inherited from BindableObject)
OnClearPlaceholderClicked()
OnFocused()
OnItemSelected(Object)
OnPropertyChanged(String)

Raises the PropertyChanged event.

(Inherited from BindableObject)
OnPropertyChanging(String)

Raises the PropertyChanging event.

(Inherited from BindableObject)
OnQueryChanged(String, String)
OnQueryConfirmed()
OnUnfocus()
RemoveBinding(BindableProperty)

Removes a previously set binding from a bindable property.

(Inherited from BindableObject)
SetBinding(BindableProperty, BindingBase)

Assigns a binding to a bindable property.

(Inherited from BindableObject)
SetIsFocused(Boolean)
SetValue(BindableProperty, Object)

Sets the value of the specified bindable property.

(Inherited from BindableObject)
SetValue(BindablePropertyKey, Object)

Sets the value of the specified bindable property.

(Inherited from BindableObject)
UnapplyBindings()

Removes all current bindings from the current context.

(Inherited from BindableObject)
Unfocus()
UpdateFormsText(String, TextTransform)

Events

BindingContextChanged

Occurs when the value of the BindingContext property changes.

(Inherited from BindableObject)
FocusChangeRequested
Focused
PropertyChanged

Occurs when a property value changes.

(Inherited from BindableObject)
PropertyChanging

Occurs when a property value is changing.

(Inherited from BindableObject)
Unfocused

Explicit Interface Implementations

IDynamicResourceHandler.SetDynamicResource(BindableProperty, String) (Inherited from BindableObject)
IFontElement.FontSizeDefaultValueCreator()
IFontElement.OnFontAttributesChanged(FontAttributes, FontAttributes)
IFontElement.OnFontAutoScalingEnabledChanged(Boolean, Boolean)
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)
SetAppTheme<T>(BindableObject, BindableProperty, T, T)
SetAppThemeColor(BindableObject, BindableProperty, Color, Color)
SetBinding(BindableObject, BindableProperty, String, BindingMode, IValueConverter, String)

Creates and applies a binding to a property.

SetBinding<TSource,TProperty>(BindableObject, BindableProperty, Func<TSource,TProperty>, BindingMode, IValueConverter, Object, String, Object, Object, Object)

Creates a binding between a property on the source object and a property on the target object.

ToFont(IFontElement, Nullable<Double>)

Applies to