SearchHandler Class
Definition
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 ref class SearchHandler : Microsoft::Maui::Controls::BindableObject, Microsoft::Maui::Controls::Internals::IFontElement, Microsoft::Maui::Controls::ISearchHandlerControllerpublic class SearchHandler : Microsoft.Maui.Controls.BindableObject, Microsoft.Maui.Controls.Internals.IFontElement, Microsoft.Maui.Controls.ISearchHandlerControllertype SearchHandler = class
inherit BindableObject
interface ISearchHandlerController
interface IFontElementPublic Class SearchHandler
Inherits BindableObject
Implements IFontElement, ISearchHandlerController- Inheritance
- Implements
Constructors
| SearchHandler() |
Fields
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 |
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 |
| 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) |
| SetValueCore(BindableProperty, Object, SetValueFlags) |
For internal use by the Microsoft.Maui.Controls platform. (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
Extension Methods
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for