Back to all docs
API Reference / Telerik.Maui.Controls / RadAutoComplete
New to Telerik UI for .NET MAUI? Start a free 30-day trial

RadAutoComplete

Class

The AutoComplete control provides suggestions while typing into a field, can complete user input and display multiple chosen tokens.

Definition

Namespace:Telerik.Maui.Controls

Assembly:Telerik.Maui.Controls.dll

Syntax:
C#
public class RadAutoComplete : RadBorder, IRadBorder, IRadContentView, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayout

Inheritance: objectRadContentViewRadBorderRadAutoComplete

Implements: IContentViewICrossPlatformLayoutIElementIPaddingIRadBorderIRadContentViewITransformIView...

Inherited Members RadBorder.BorderColorPropertyRadBorder.CornerRadiusPropertyRadBorder.BorderThicknessPropertyRadBorder.BorderBrushPropertyRadBorder.ChangeVisualState()RadBorder.BorderColorRadBorder.CornerRadiusRadBorder.BorderThicknessRadBorder.BorderBrushRadContentView.ActualStyleClassPropertyRadContentView.OnChildAdded(Element)RadContentView.OnChildRemoved(Element, int)RadContentView.OnBindingContextChanged()RadContentView.OnHandlerChanged()...

Constructors

RadAutoComplete()

Initializes a new instance of the RadAutoComplete class.

C#
public RadAutoComplete()

Fields

ActualClearButtonStyleProperty

BindableProperty

Identifies the ActualClearButtonStyle property.

C#
public static readonly BindableProperty ActualClearButtonStyleProperty

ActualSuggestionItemStyleProperty

BindableProperty

Identifies the ActualSuggestionItemStyle property.

C#
public static readonly BindableProperty ActualSuggestionItemStyleProperty

ActualTextInputStyleProperty

BindableProperty

Identifies the ActualTextInputStyle property.

C#
public static readonly BindableProperty ActualTextInputStyleProperty

BackgroundColorProperty

BindableProperty

Identifies the BackgroundColor property.

C#
public static readonly BindableProperty BackgroundColorProperty

ClearButtonStyleProperty

BindableProperty

Identifies the ClearButtonStyle property.

C#
public static readonly BindableProperty ClearButtonStyleProperty

ClearTextCommandProperty

BindableProperty

Identifies the ClearTextCommand property.

C#
public static readonly BindableProperty ClearTextCommandProperty

CompletionModeProperty

BindableProperty

Identifies the CompletionMode property.

C#
public static readonly BindableProperty CompletionModeProperty

ControlTemplateProperty

BindableProperty

Identifies the ControlTemplate property.

C#
public static readonly BindableProperty ControlTemplateProperty

DisplayModeProperty

BindableProperty

Identifies the DisplayMode property.

C#
public static readonly BindableProperty DisplayModeProperty

DisplayTextFormatterProperty

BindableProperty

Identifies the DisplayTextFormatter property.

C#
public static readonly BindableProperty DisplayTextFormatterProperty

FilteredItemsProperty

BindableProperty

Identifies the FilteredItems property.

C#
public static readonly BindableProperty FilteredItemsProperty

FilterProperty

BindableProperty

Identifies the Filter property.

C#
public static readonly BindableProperty FilterProperty

FontAttributesProperty

BindableProperty

Identifies the FontAttributes property.

C#
public static readonly BindableProperty FontAttributesProperty

FontFamilyProperty

BindableProperty

Identifies the FontFamily property.

C#
public static readonly BindableProperty FontFamilyProperty

FontSizeProperty

BindableProperty

Identifies the FontSize property.

C#
public static readonly BindableProperty FontSizeProperty

HighlightItemFuncProperty

BindableProperty

Identifies the HighlightItemFunc property.

C#
public static readonly BindableProperty HighlightItemFuncProperty

IsClearButtonVisibleProperty

BindableProperty

Identifies the IsClearButtonVisible property.

C#
public static readonly BindableProperty IsClearButtonVisibleProperty

ItemsSourceProperty

BindableProperty

Identifies the ItemsSource property.

C#
public static readonly BindableProperty ItemsSourceProperty

KeyboardProperty

BindableProperty

Identifies the Keyboard property.

C#
public static readonly BindableProperty KeyboardProperty

LoadingTemplateProperty

BindableProperty

Identifies the LoadingTemplate property.

C#
public static readonly BindableProperty LoadingTemplateProperty

NoResultsMessageProperty

BindableProperty

Identifies the NoResultsMessage property.

C#
public static readonly BindableProperty NoResultsMessageProperty

NoResultsTemplateProperty

BindableProperty

Identifies the NoResultsTemplate property.

C#
public static readonly BindableProperty NoResultsTemplateProperty

PlaceholderColorProperty

BindableProperty

Identifies the PlaceholderColor property.

C#
public static readonly BindableProperty PlaceholderColorProperty

PlaceholderProperty

BindableProperty

Identifies the Placeholder property.

C#
public static readonly BindableProperty PlaceholderProperty

RemoveTokenCommandProperty

BindableProperty

Identifies the RemoveTokenCommand property.

C#
public static readonly BindableProperty RemoveTokenCommandProperty

SearchTextProperty

BindableProperty

Identifies the SearchText property.

C#
public static readonly BindableProperty SearchTextProperty

SearchThresholdProperty

BindableProperty

Identifies the SearchThreshold property.

C#
public static readonly BindableProperty SearchThresholdProperty

ShowMoreItemsProperty

BindableProperty

Identifies the ShowMoreItems property.

C#
public static readonly BindableProperty ShowMoreItemsProperty

ShowMoreTemplateProperty

BindableProperty

Identifies the ShowMoreTemplate property.

C#
public static readonly BindableProperty ShowMoreTemplateProperty

ShowSuggestionViewProperty

BindableProperty

Identifies the ShowSuggestionView property.

C#
public static readonly BindableProperty ShowSuggestionViewProperty

StyleProperty

BindableProperty

Identifies the Style property.

C#
public static readonly BindableProperty StyleProperty

SuggestionItemHighlightTextColorProperty

BindableProperty

Identifies the SuggestionItemHighlightTextColor property.

C#
public static readonly BindableProperty SuggestionItemHighlightTextColorProperty

SuggestionItemStyleProperty

BindableProperty

Identifies the SuggestionItemStyle property.

C#
public static readonly BindableProperty SuggestionItemStyleProperty

SuggestionItemTemplateProperty

BindableProperty

Identifies the SuggestionItemTemplate property.

C#
public static readonly BindableProperty SuggestionItemTemplateProperty

SuggestionViewBackgroundColorProperty

BindableProperty

Identifies the SuggestionViewBackgroundColor property.

C#
public static readonly BindableProperty SuggestionViewBackgroundColorProperty

SuggestionViewBorderColorProperty

BindableProperty

Identifies the SuggestionViewBorderColor property.

C#
public static readonly BindableProperty SuggestionViewBorderColorProperty

SuggestionViewBorderThicknessProperty

BindableProperty

Identifies the SuggestionViewBorderThickness property.

C#
public static readonly BindableProperty SuggestionViewBorderThicknessProperty

SuggestionViewCornerRadiusProperty

BindableProperty

Identifies the SuggestionViewCornerRadius property.

C#
public static readonly BindableProperty SuggestionViewCornerRadiusProperty

SuggestionViewHeightProperty

BindableProperty

Identifies the SuggestionViewHeight property.

C#
public static readonly BindableProperty SuggestionViewHeightProperty

SuggestionViewMaxHeightProperty

BindableProperty

Identifies the SuggestionViewMaxHeight property.

C#
public static readonly BindableProperty SuggestionViewMaxHeightProperty

SuggestionViewPositionProperty

BindableProperty

Identifies the SuggestionViewPosition property.

C#
public static readonly BindableProperty SuggestionViewPositionProperty

SuggestionViewTemplateProperty

BindableProperty

Identifies the SuggestionViewTemplate property.

C#
public static readonly BindableProperty SuggestionViewTemplateProperty

SuggestModeProperty

BindableProperty

Identifies the SuggestMode property.

C#
public static readonly BindableProperty SuggestModeProperty

TextColorProperty

BindableProperty

Identifies the TextColor property.

C#
public static readonly BindableProperty TextColorProperty

TextInputStyleProperty

BindableProperty

Identifies the TextInputStyle property.

C#
public static readonly BindableProperty TextInputStyleProperty

TextProperty

BindableProperty

Identifies the Text property.

C#
public static readonly BindableProperty TextProperty

TextSearchPathProperty

BindableProperty

Identifies the TextSearchPath property.

C#
public static readonly BindableProperty TextSearchPathProperty

TokensProperty

BindableProperty

Identifies the Tokens property.

C#
public static readonly BindableProperty TokensProperty

TokenTemplateProperty

BindableProperty

Identifies the TokenTemplate property.

C#
public static readonly BindableProperty TokenTemplateProperty

Properties

ActualClearButtonStyle

Style

Gets the actual style that is used to style the clear button.

C#
public Style ActualClearButtonStyle { get; }

ActualSuggestionItemStyle

Style

Gets the actual Style for the suggestion items in the drop down.

C#
public Style ActualSuggestionItemStyle { get; }

ActualTextInputStyle

Style

Gets the actual Style for the inner RadTextInput.

C#
public Style ActualTextInputStyle { get; }

BackgroundColor

Color

C#
public Color BackgroundColor { get; set; }

ClearButtonStyle

Style

Gets or sets the Style of the clear button.

C#
public Style ClearButtonStyle { get; set; }

ClearTextCommand

Gets or sets the command that sets the text to null.

C#
public ICommand ClearTextCommand { get; set; }

CompletionMode

Gets or sets the AutoCompleteCompletionMode of the component.

C#
public AutoCompleteCompletionMode CompletionMode { get; set; }

ControlTemplate

ControlTemplate

Gets or sets the control template of this view.

C#
public ControlTemplate ControlTemplate { get; set; }

DisplayMode

Gets or sets the AutoCompleteDisplayMode of the component.

C#
public AutoCompleteDisplayMode DisplayMode { get; set; }

DisplayTextFormatter

Gets or set the formatter of the selected item. Using it the format of the text visualized in the entry could be formated when AutoCompleteDisplayMode is Plain. If the AutoCompleteDisplayMode is Token you can format the text visualized in the Token itself.

C#
[TypeConverter(typeof(DisplayTextFormatterTypeConverter))]
public IDisplayTextFormatter DisplayTextFormatter { get; set; }

Filter

Gets or sets the function that will be used to filter items. When set TextSearchPath property is ignored.

C#
public IAutoCompleteFilter Filter { get; set; }

FilteredItems

Gets the FilteredItems of the component.

C#
public IEnumerable FilteredItems { get; }

FontAttributes

FontAttributes

Gets or sets the FontAttributes of the component.

C#
public FontAttributes FontAttributes { get; set; }

FontFamily

Gets or sets the FontFamily of the component.

C#
public string FontFamily { get; set; }

FontSize

Gets or sets the FontSize of the component.

C#
[TypeConverter(typeof(FontSizeConverter))]
public double FontSize { get; set; }

HighlightItemFunc

Gets or sets the function used to specify the highlighted item in the drop down after filtering is performed.

C#
public Func<IEnumerable<object>, string, object> HighlightItemFunc { get; set; }
Remarks:

The function receives the filtered collection of items and current search text, and returns the item that should be highlighted.

IsClearButtonVisible

Gets or sets a value indicating if the clear button should be visible.

C#
public bool IsClearButtonVisible { get; set; }
Remarks:

When False Clear button will never be visible. Otherwise it will be visible only when control is focused.

ItemsSource

Gets or sets the ItemsSource of the component.

C#
public IEnumerable ItemsSource { get; set; }

Keyboard

Keyboard

Gets or sets type of the keyboard that will be visualized by the device.

C#
public Keyboard Keyboard { get; set; }

LoadingTemplate

DataTemplate

Gets or sets the loading message.

C#
public DataTemplate LoadingTemplate { get; set; }

NoResultsMessage

Gets or sets the message visualised when there are no suggestions found.

C#
public string NoResultsMessage { get; set; }

NoResultsTemplate

DataTemplate

Gets or sets the template visualised when there are no suggestions found.

C#
public DataTemplate NoResultsTemplate { get; set; }

Placeholder

Gets or sets the placeholder text of the component.

C#
public string Placeholder { get; set; }

PlaceholderColor

Color

Gets or sets the placeholder color of the component.

C#
public Color PlaceholderColor { get; set; }
Property Value:

The Color.

RemoveTokenCommand

Gets or sets the command that removes the tokens. The parameter of this command is a token from the Tokens collection.

C#
public ICommand RemoveTokenCommand { get; set; }

SearchText

Gets the search Text.

C#
public string SearchText { get; }

SearchThreshold

Gets or sets the SearchThreshold of the component.

C#
public int SearchThreshold { get; set; }

ShowMoreItems

Gets or sets the visibility of the view that is used to represents more items.

C#
public bool ShowMoreItems { get; set; }
Remarks:

When true and ShowMoreTemplate is set RadAutoComplete will hide tokens that are not on the first line and will show the hidden count.

ShowMoreTemplate

DataTemplate

Gets or sets the template used to create show more view.

C#
public DataTemplate ShowMoreTemplate { get; set; }

ShowSuggestionView

Gets or sets a value indicating if the suggestions should be visualized.

C#
public bool ShowSuggestionView { get; set; }

Style

Style

Gets or sets the Style of the control.

C#
public Style Style { get; set; }

SuggestionItemHighlightTextColor

Color

Gets or sets the SuggestionItemHighlightTextColor of the component.

C#
public Color SuggestionItemHighlightTextColor { get; set; }

SuggestionItemStyle

Style

Gets or sets the Suggestion Item Style of the component (TargetType RadCollectionViewItemView).

C#
public Style SuggestionItemStyle { get; set; }

SuggestionItemTemplate

DataTemplate

Gets or sets the SuggestionItemTemplate of the component.

C#
public DataTemplate SuggestionItemTemplate { get; set; }

SuggestionViewBackgroundColor

Color

Gets or sets the SuggestionViewBackgroundColor of the component.

C#
public Color SuggestionViewBackgroundColor { get; set; }

SuggestionViewBorderColor

Color

Gets or sets the border color of the suggestion view of the component.

C#
public Color SuggestionViewBorderColor { get; set; }

SuggestionViewBorderThickness

Thickness

Gets or sets the border thickness of the suggestion view of the component.

C#
public Thickness SuggestionViewBorderThickness { get; set; }

SuggestionViewCornerRadius

Thickness

Gets or sets the corner radius of the suggestion view of the component.

C#
public Thickness SuggestionViewCornerRadius { get; set; }

SuggestionViewHeight

Gets or sets the height of the suggestion view of the component.

C#
public double SuggestionViewHeight { get; set; }
Property Value:

The required SuggestionView height.

SuggestionViewMaxHeight

Gets or sets the max height of the suggestion view of the component.

C#
public double SuggestionViewMaxHeight { get; set; }
Property Value:

The required SuggestionView max height.

SuggestionViewPosition

Gets or sets the Position for the suggestion view popup.

C#
public AutoCompletePopupPosition SuggestionViewPosition { get; set; }

SuggestionViewTemplate

DataTemplate

Gets or sets the template used to visualize the filtered items.

C#
public DataTemplate SuggestionViewTemplate { get; set; }

SuggestMode

Gets or sets the AutoCompleteSuggestMode of the component.

C#
public AutoCompleteSuggestMode SuggestMode { get; set; }
Property Value:

The AutoCompleteSuggestMode.

Text

Gets the visualized Text.

C#
public string Text { get; set; }

TextColor

Color

Gets or sets the TextColor of the component.

C#
public Color TextColor { get; set; }
Property Value:

The Color.

TextInputStyle

Style

Gets or sets the Style of the inner RadTextInput.

C#
public Style TextInputStyle { get; set; }

TextSearchPath

Gets or sets the TextSearchPath of the component.

C#
public string TextSearchPath { get; set; }
Property Value:

The TextSearchPath.

Tokens

Gets the available Tokens.

C#
public ObservableCollection<object> Tokens { get; }

TokenTemplate

DataTemplate

Gets or sets the template used to visualize tokens.

C#
public DataTemplate TokenTemplate { get; set; }
Property Value:

The TokenTemplate.

Methods

Focus()

Attempts to set focus to this element.

C#
public bool Focus()
Returns:

bool

HideSuggestions()

Hides suggestions.

C#
public void HideSuggestions()

OnApplyTemplate()

C#
protected override void OnApplyTemplate()

OnPropertyChanged(string)

C#
protected override void OnPropertyChanged(string propertyName = null)
Parameters:propertyNamestring

ShowSuggestions()

Shows suggestions.

C#
public void ShowSuggestions()

Unfocus()

Unsets keyboard focus on this element.

C#
public void Unfocus()

Events

Completed

Occurs when the user finalizes the text in the AutoCompleteView Entry with the return key.

C#
public event EventHandler Completed

FilteredItemsChanged

Occurs when the FilteredItems collection is changed.

C#
public event EventHandler<FilteredItemsChangedEventArgs> FilteredItemsChanged

SuggestionItemSelected

Occurs when a suggestion is selected.

C#
public event EventHandler<SuggestionItemSelectedEventArgs> SuggestionItemSelected

TextChanged

EventHandler<TextChangedEventArgs>

Occurs when the text is changed.

C#
public event EventHandler<TextChangedEventArgs> TextChanged
In this article
DefinitionConstructorsRadAutoComplete()FieldsActualClearButtonStylePropertyActualSuggestionItemStylePropertyActualTextInputStylePropertyBackgroundColorPropertyClearButtonStylePropertyClearTextCommandPropertyCompletionModePropertyControlTemplatePropertyDisplayModePropertyDisplayTextFormatterPropertyFilterPropertyFilteredItemsPropertyFontAttributesPropertyFontFamilyPropertyFontSizePropertyHighlightItemFuncPropertyIsClearButtonVisiblePropertyItemsSourcePropertyKeyboardPropertyLoadingTemplatePropertyNoResultsMessagePropertyNoResultsTemplatePropertyPlaceholderColorPropertyPlaceholderPropertyRemoveTokenCommandPropertySearchTextPropertySearchThresholdPropertyShowMoreItemsPropertyShowMoreTemplatePropertyShowSuggestionViewPropertyStylePropertySuggestModePropertySuggestionItemHighlightTextColorPropertySuggestionItemStylePropertySuggestionItemTemplatePropertySuggestionViewBackgroundColorPropertySuggestionViewBorderColorPropertySuggestionViewBorderThicknessPropertySuggestionViewCornerRadiusPropertySuggestionViewHeightPropertySuggestionViewMaxHeightPropertySuggestionViewPositionPropertySuggestionViewTemplatePropertyTextColorPropertyTextInputStylePropertyTextPropertyTextSearchPathPropertyTokenTemplatePropertyTokensPropertyPropertiesActualClearButtonStyleActualSuggestionItemStyleActualTextInputStyleBackgroundColorClearButtonStyleClearTextCommandCompletionModeControlTemplateDisplayModeDisplayTextFormatterFilterFilteredItemsFontAttributesFontFamilyFontSizeHighlightItemFuncIsClearButtonVisibleItemsSourceKeyboardLoadingTemplateNoResultsMessageNoResultsTemplatePlaceholderPlaceholderColorRemoveTokenCommandSearchTextSearchThresholdShowMoreItemsShowMoreTemplateShowSuggestionViewStyleSuggestModeSuggestionItemHighlightTextColorSuggestionItemStyleSuggestionItemTemplateSuggestionViewBackgroundColorSuggestionViewBorderColorSuggestionViewBorderThicknessSuggestionViewCornerRadiusSuggestionViewHeightSuggestionViewMaxHeightSuggestionViewPositionSuggestionViewTemplateTextTextColorTextInputStyleTextSearchPathTokenTemplateTokensMethodsFocus()HideSuggestions()OnApplyTemplate()OnPropertyChanged(string)ShowSuggestions()Unfocus()EventsCompletedFilteredItemsChangedSuggestionItemSelectedTextChanged
Not finding the help you need?
Contact Support