Class
RadAutoComplete

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:

cs-api-definition
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.

Declaration

cs-api-definition
public RadAutoComplete()

Fields

ActualClearButtonStyleProperty

Identifies the ActualClearButtonStyle property.

Declaration

cs-api-definition
public static readonly BindableProperty ActualClearButtonStyleProperty

Field Value

BindableProperty

ActualTextInputStyleProperty

Identifies the ActualTextInputStyle property.

Declaration

cs-api-definition
public static readonly BindableProperty ActualTextInputStyleProperty

Field Value

BindableProperty

BackgroundColorProperty

Identifies the BackgroundColor property.

Declaration

cs-api-definition
public static readonly BindableProperty BackgroundColorProperty

Field Value

BindableProperty

ClearButtonStyleProperty

Identifies the ClearButtonStyle property.

Declaration

cs-api-definition
public static readonly BindableProperty ClearButtonStyleProperty

Field Value

BindableProperty

ClearTextCommandProperty

Identifies the ClearTextCommand property.

Declaration

cs-api-definition
public static readonly BindableProperty ClearTextCommandProperty

Field Value

BindableProperty

CompletionModeProperty

Identifies the CompletionMode property.

Declaration

cs-api-definition
public static readonly BindableProperty CompletionModeProperty

Field Value

BindableProperty

ControlTemplateProperty

Identifies the ControlTemplate property.

Declaration

cs-api-definition
public static readonly BindableProperty ControlTemplateProperty

Field Value

BindableProperty

DisplayModeProperty

Identifies the DisplayMode property.

Declaration

cs-api-definition
public static readonly BindableProperty DisplayModeProperty

Field Value

BindableProperty

DisplayTextFormatterProperty

Identifies the DisplayTextFormatter property.

Declaration

cs-api-definition
public static readonly BindableProperty DisplayTextFormatterProperty

Field Value

BindableProperty

FilterProperty

Identifies the Filter property.

Declaration

cs-api-definition
public static readonly BindableProperty FilterProperty

Field Value

BindableProperty

FilteredItemsProperty

Identifies the FilteredItems property.

Declaration

cs-api-definition
public static readonly BindableProperty FilteredItemsProperty

Field Value

BindableProperty

FontAttributesProperty

Identifies the FontAttributes property.

Declaration

cs-api-definition
public static readonly BindableProperty FontAttributesProperty

Field Value

BindableProperty

FontFamilyProperty

Identifies the FontFamily property.

Declaration

cs-api-definition
public static readonly BindableProperty FontFamilyProperty

Field Value

BindableProperty

FontSizeProperty

Identifies the FontSize property.

Declaration

cs-api-definition
public static readonly BindableProperty FontSizeProperty

Field Value

BindableProperty

IsClearButtonVisibleProperty

Identifies the IsClearButtonVisible property.

Declaration

cs-api-definition
public static readonly BindableProperty IsClearButtonVisibleProperty

Field Value

BindableProperty

ItemsSourceProperty

Identifies the ItemsSource property.

Declaration

cs-api-definition
public static readonly BindableProperty ItemsSourceProperty

Field Value

BindableProperty

KeyboardProperty

Identifies the Keyboard property.

Declaration

cs-api-definition
public static readonly BindableProperty KeyboardProperty

Field Value

BindableProperty

LoadingTemplateProperty

Identifies the LoadingTemplate property.

Declaration

cs-api-definition
public static readonly BindableProperty LoadingTemplateProperty

Field Value

BindableProperty

NoResultsMessageProperty

Identifies the NoResultsMessage property.

Declaration

cs-api-definition
public static readonly BindableProperty NoResultsMessageProperty

Field Value

BindableProperty

NoResultsTemplateProperty

Identifies the NoResultsTemplate property.

Declaration

cs-api-definition
public static readonly BindableProperty NoResultsTemplateProperty

Field Value

BindableProperty

PlaceholderColorProperty

Identifies the PlaceholderColor property.

Declaration

cs-api-definition
public static readonly BindableProperty PlaceholderColorProperty

Field Value

BindableProperty

PlaceholderProperty

Identifies the Placeholder property.

Declaration

cs-api-definition
public static readonly BindableProperty PlaceholderProperty

Field Value

BindableProperty

RemoveTokenCommandProperty

Identifies the RemoveTokenCommand property.

Declaration

cs-api-definition
public static readonly BindableProperty RemoveTokenCommandProperty

Field Value

BindableProperty

SearchTextProperty

Identifies the SearchText property.

Declaration

cs-api-definition
public static readonly BindableProperty SearchTextProperty

Field Value

BindableProperty

SearchThresholdProperty

Identifies the SearchThreshold property.

Declaration

cs-api-definition
public static readonly BindableProperty SearchThresholdProperty

Field Value

BindableProperty

ShowMoreItemsProperty

Identifies the ShowMoreItems property.

Declaration

cs-api-definition
public static readonly BindableProperty ShowMoreItemsProperty

Field Value

BindableProperty

ShowMoreTemplateProperty

Identifies the ShowMoreTemplate property.

Declaration

cs-api-definition
public static readonly BindableProperty ShowMoreTemplateProperty

Field Value

BindableProperty

ShowSuggestionViewProperty

Identifies the ShowSuggestionView property.

Declaration

cs-api-definition
public static readonly BindableProperty ShowSuggestionViewProperty

Field Value

BindableProperty

StyleProperty

Identifies the Style property.

Declaration

cs-api-definition
public static readonly BindableProperty StyleProperty

Field Value

BindableProperty

SuggestModeProperty

Identifies the SuggestMode property.

Declaration

cs-api-definition
public static readonly BindableProperty SuggestModeProperty

Field Value

BindableProperty

SuggestionItemHighlightTextColorProperty

Identifies the SuggestionItemHighlightTextColor property.

Declaration

cs-api-definition
public static readonly BindableProperty SuggestionItemHighlightTextColorProperty

Field Value

BindableProperty

SuggestionItemStyleProperty

Identifies the SuggestionItemStyle property.

Declaration

cs-api-definition
public static readonly BindableProperty SuggestionItemStyleProperty

Field Value

BindableProperty

SuggestionItemTemplateProperty

Identifies the SuggestionItemTemplate property.

Declaration

cs-api-definition
public static readonly BindableProperty SuggestionItemTemplateProperty

Field Value

BindableProperty

SuggestionViewBackgroundColorProperty

Identifies the SuggestionViewBackgroundColor property.

Declaration

cs-api-definition
public static readonly BindableProperty SuggestionViewBackgroundColorProperty

Field Value

BindableProperty

SuggestionViewBorderColorProperty

Identifies the SuggestionViewBorderColor property.

Declaration

cs-api-definition
public static readonly BindableProperty SuggestionViewBorderColorProperty

Field Value

BindableProperty

SuggestionViewBorderThicknessProperty

Identifies the SuggestionViewBorderThickness property.

Declaration

cs-api-definition
public static readonly BindableProperty SuggestionViewBorderThicknessProperty

Field Value

BindableProperty

SuggestionViewCornerRadiusProperty

Identifies the SuggestionViewCornerRadius property.

Declaration

cs-api-definition
public static readonly BindableProperty SuggestionViewCornerRadiusProperty

Field Value

BindableProperty

SuggestionViewHeightProperty

Identifies the SuggestionViewHeight property.

Declaration

cs-api-definition
public static readonly BindableProperty SuggestionViewHeightProperty

Field Value

BindableProperty

SuggestionViewMaxHeightProperty

Identifies the SuggestionViewMaxHeight property.

Declaration

cs-api-definition
public static readonly BindableProperty SuggestionViewMaxHeightProperty

Field Value

BindableProperty

SuggestionViewPositionProperty

Identifies the SuggestionViewPosition property.

Declaration

cs-api-definition
public static readonly BindableProperty SuggestionViewPositionProperty

Field Value

BindableProperty

SuggestionViewTemplateProperty

Identifies the SuggestionViewTemplate property.

Declaration

cs-api-definition
public static readonly BindableProperty SuggestionViewTemplateProperty

Field Value

BindableProperty

TextColorProperty

Identifies the TextColor property.

Declaration

cs-api-definition
public static readonly BindableProperty TextColorProperty

Field Value

BindableProperty

TextInputStyleProperty

Identifies the TextInputStyle property.

Declaration

cs-api-definition
public static readonly BindableProperty TextInputStyleProperty

Field Value

BindableProperty

TextProperty

Identifies the Text property.

Declaration

cs-api-definition
public static readonly BindableProperty TextProperty

Field Value

BindableProperty

TextSearchPathProperty

Identifies the TextSearchPath property.

Declaration

cs-api-definition
public static readonly BindableProperty TextSearchPathProperty

Field Value

BindableProperty

TokenTemplateProperty

Identifies the TokenTemplate property.

Declaration

cs-api-definition
public static readonly BindableProperty TokenTemplateProperty

Field Value

BindableProperty

TokensProperty

Identifies the Tokens property.

Declaration

cs-api-definition
public static readonly BindableProperty TokensProperty

Field Value

BindableProperty

Properties

ActualClearButtonStyle

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

Declaration

cs-api-definition
public Style ActualClearButtonStyle { get; }

Property Value

Style

ActualTextInputStyle

Gets the actual Style for the inner RadTextInput.

Declaration

cs-api-definition
public Style ActualTextInputStyle { get; }

Property Value

Style

BackgroundColor

Declaration

cs-api-definition
public Color BackgroundColor { get; set; }

Property Value

Color

ClearButtonStyle

Gets or sets the Style of the clear button.

Declaration

cs-api-definition
public Style ClearButtonStyle { get; set; }

Property Value

Style

ClearTextCommand

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

Declaration

cs-api-definition
public ICommand ClearTextCommand { get; set; }

Property Value

ICommand

CompletionMode

Gets or sets the AutoCompleteCompletionMode of the component.

Declaration

cs-api-definition
public AutoCompleteCompletionMode CompletionMode { get; set; }

Property Value

AutoCompleteCompletionMode

ControlTemplate

Gets or sets the control template of this view.

Declaration

cs-api-definition
public ControlTemplate ControlTemplate { get; set; }

Property Value

ControlTemplate

DisplayMode

Gets or sets the AutoCompleteDisplayMode of the component.

Declaration

cs-api-definition
public AutoCompleteDisplayMode DisplayMode { get; set; }

Property Value

AutoCompleteDisplayMode

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.

Declaration

cs-api-definition
[TypeConverter(typeof(DisplayTextFormatterTypeConverter))]
public IDisplayTextFormatter DisplayTextFormatter { get; set; }

Property Value

IDisplayTextFormatter

Filter

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

Declaration

cs-api-definition
public IAutoCompleteFilter Filter { get; set; }

Property Value

IAutoCompleteFilter

FilteredItems

Gets the FilteredItems of the component.

Declaration

cs-api-definition
public IEnumerable FilteredItems { get; }

Property Value

IEnumerable

FontAttributes

Gets or sets the FontAttributes of the component.

Declaration

cs-api-definition
public FontAttributes FontAttributes { get; set; }

Property Value

FontAttributes

FontFamily

Gets or sets the FontFamily of the component.

Declaration

cs-api-definition
public string FontFamily { get; set; }

Property Value

string

FontSize

Gets or sets the FontSize of the component.

Declaration

cs-api-definition
[TypeConverter(typeof(FontSizeConverter))]
public double FontSize { get; set; }

Property Value

double

IsClearButtonVisible

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

Declaration

cs-api-definition
public bool IsClearButtonVisible { get; set; }

Property Value

bool

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.

Declaration

cs-api-definition
public IEnumerable ItemsSource { get; set; }

Property Value

IEnumerable

Keyboard

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

Declaration

cs-api-definition
public Keyboard Keyboard { get; set; }

Property Value

Keyboard

LoadingTemplate

Gets or sets the loading message.

Declaration

cs-api-definition
public DataTemplate LoadingTemplate { get; set; }

Property Value

DataTemplate

NoResultsMessage

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

Declaration

cs-api-definition
public string NoResultsMessage { get; set; }

Property Value

string

NoResultsTemplate

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

Declaration

cs-api-definition
public DataTemplate NoResultsTemplate { get; set; }

Property Value

DataTemplate

Placeholder

Gets or sets the placeholder text of the component.

Declaration

cs-api-definition
public string Placeholder { get; set; }

Property Value

string

PlaceholderColor

Gets or sets the placeholder color of the component.

Declaration

cs-api-definition
public Color PlaceholderColor { get; set; }

Property Value

Color

The Color.

RemoveTokenCommand

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

Declaration

cs-api-definition
public ICommand RemoveTokenCommand { get; set; }

Property Value

ICommand

SearchText

Gets the search Text.

Declaration

cs-api-definition
public string SearchText { get; }

Property Value

string

SearchThreshold

Gets or sets the SearchThreshold of the component.

Declaration

cs-api-definition
public int SearchThreshold { get; set; }

Property Value

int

ShowMoreItems

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

Declaration

cs-api-definition
public bool ShowMoreItems { get; set; }

Property Value

bool

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

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

Declaration

cs-api-definition
public DataTemplate ShowMoreTemplate { get; set; }

Property Value

DataTemplate

ShowSuggestionView

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

Declaration

cs-api-definition
public bool ShowSuggestionView { get; set; }

Property Value

bool

Style

Gets or sets the Style of the control.

Declaration

cs-api-definition
public Style Style { get; set; }

Property Value

Style

SuggestMode

Gets or sets the AutoCompleteSuggestMode of the component.

Declaration

cs-api-definition
public AutoCompleteSuggestMode SuggestMode { get; set; }

Property Value

AutoCompleteSuggestMode

The AutoCompleteSuggestMode.

SuggestionItemHighlightTextColor

Gets or sets the SuggestionItemHighlightTextColor of the component.

Declaration

cs-api-definition
public Color SuggestionItemHighlightTextColor { get; set; }

Property Value

Color

SuggestionItemStyle

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

Declaration

cs-api-definition
public Style SuggestionItemStyle { get; set; }

Property Value

Style

SuggestionItemTemplate

Gets or sets the SuggestionItemTemplate of the component.

Declaration

cs-api-definition
public DataTemplate SuggestionItemTemplate { get; set; }

Property Value

DataTemplate

SuggestionViewBackgroundColor

Gets or sets the SuggestionViewBackgroundColor of the component.

Declaration

cs-api-definition
public Color SuggestionViewBackgroundColor { get; set; }

Property Value

Color

SuggestionViewBorderColor

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

Declaration

cs-api-definition
public Color SuggestionViewBorderColor { get; set; }

Property Value

Color

SuggestionViewBorderThickness

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

Declaration

cs-api-definition
public Thickness SuggestionViewBorderThickness { get; set; }

Property Value

Thickness

SuggestionViewCornerRadius

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

Declaration

cs-api-definition
public Thickness SuggestionViewCornerRadius { get; set; }

Property Value

Thickness

SuggestionViewHeight

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

Declaration

cs-api-definition
public double SuggestionViewHeight { get; set; }

Property Value

double

The required SuggestionView height.

SuggestionViewMaxHeight

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

Declaration

cs-api-definition
public double SuggestionViewMaxHeight { get; set; }

Property Value

double

The required SuggestionView max height.

SuggestionViewPosition

Gets or sets the Position for the suggestion view popup.

Declaration

cs-api-definition
public AutoCompletePopupPosition SuggestionViewPosition { get; set; }

Property Value

AutoCompletePopupPosition

SuggestionViewTemplate

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

Declaration

cs-api-definition
public DataTemplate SuggestionViewTemplate { get; set; }

Property Value

DataTemplate

Text

Gets the visualized Text.

Declaration

cs-api-definition
public string Text { get; set; }

Property Value

string

TextColor

Gets or sets the TextColor of the component.

Declaration

cs-api-definition
public Color TextColor { get; set; }

Property Value

Color

The Color.

TextInputStyle

Gets or sets the Style of the inner RadTextInput.

Declaration

cs-api-definition
public Style TextInputStyle { get; set; }

Property Value

Style

TextSearchPath

Gets or sets the TextSearchPath of the component.

Declaration

cs-api-definition
public string TextSearchPath { get; set; }

Property Value

string

The TextSearchPath.

TokenTemplate

Gets or sets the template used to visualize tokens.

Declaration

cs-api-definition
public DataTemplate TokenTemplate { get; set; }

Property Value

DataTemplate

The TokenTemplate.

Tokens

Gets the available Tokens.

Declaration

cs-api-definition
public ObservableCollection<object> Tokens { get; }

Property Value

ObservableCollection<object>

Methods

Focus()

Attempts to set focus to this element.

Declaration

cs-api-definition
public bool Focus()

Returns

bool

HideSuggestions()

Hides suggestions.

Declaration

cs-api-definition
public void HideSuggestions()

OnApplyTemplate()

Declaration

cs-api-definition
protected override void OnApplyTemplate()

OnPropertyChanged(string)

Declaration

cs-api-definition
protected override void OnPropertyChanged(string propertyName = null)

Parameters

propertyName

string

ShowSuggestions()

Shows suggestions.

Declaration

cs-api-definition
public void ShowSuggestions()

Unfocus()

Unsets keyboard focus on this element.

Declaration

cs-api-definition
public void Unfocus()

Events

Completed

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

Declaration

cs-api-definition
public event EventHandler Completed

Event Value

EventHandler

FilteredItemsChanged

Occurs when the FilteredItems collection is changed.

Declaration

cs-api-definition
public event EventHandler<FilteredItemsChangedEventArgs> FilteredItemsChanged

Event Value

EventHandler<FilteredItemsChangedEventArgs>

SuggestionItemSelected

Occurs when a suggestion is selected.

Declaration

cs-api-definition
public event EventHandler<SuggestionItemSelectedEventArgs> SuggestionItemSelected

Event Value

EventHandler<SuggestionItemSelectedEventArgs>

TextChanged

Occurs when the text is changed.

Declaration

cs-api-definition
public event EventHandler<TextChangedEventArgs> TextChanged

Event Value

EventHandler<TextChangedEventArgs>

In this article
DefinitionConstructorsRadAutoComplete()FieldsActualClearButtonStylePropertyActualTextInputStylePropertyBackgroundColorPropertyClearButtonStylePropertyClearTextCommandPropertyCompletionModePropertyControlTemplatePropertyDisplayModePropertyDisplayTextFormatterPropertyFilterPropertyFilteredItemsPropertyFontAttributesPropertyFontFamilyPropertyFontSizePropertyIsClearButtonVisiblePropertyItemsSourcePropertyKeyboardPropertyLoadingTemplatePropertyNoResultsMessagePropertyNoResultsTemplatePropertyPlaceholderColorPropertyPlaceholderPropertyRemoveTokenCommandPropertySearchTextPropertySearchThresholdPropertyShowMoreItemsPropertyShowMoreTemplatePropertyShowSuggestionViewPropertyStylePropertySuggestModePropertySuggestionItemHighlightTextColorPropertySuggestionItemStylePropertySuggestionItemTemplatePropertySuggestionViewBackgroundColorPropertySuggestionViewBorderColorPropertySuggestionViewBorderThicknessPropertySuggestionViewCornerRadiusPropertySuggestionViewHeightPropertySuggestionViewMaxHeightPropertySuggestionViewPositionPropertySuggestionViewTemplatePropertyTextColorPropertyTextInputStylePropertyTextPropertyTextSearchPathPropertyTokenTemplatePropertyTokensPropertyPropertiesActualClearButtonStyleActualTextInputStyleBackgroundColorClearButtonStyleClearTextCommandCompletionModeControlTemplateDisplayModeDisplayTextFormatterFilterFilteredItemsFontAttributesFontFamilyFontSizeIsClearButtonVisibleItemsSourceKeyboardLoadingTemplateNoResultsMessageNoResultsTemplatePlaceholderPlaceholderColorRemoveTokenCommandSearchTextSearchThresholdShowMoreItemsShowMoreTemplateShowSuggestionViewStyleSuggestModeSuggestionItemHighlightTextColorSuggestionItemStyleSuggestionItemTemplateSuggestionViewBackgroundColorSuggestionViewBorderColorSuggestionViewBorderThicknessSuggestionViewCornerRadiusSuggestionViewHeightSuggestionViewMaxHeightSuggestionViewPositionSuggestionViewTemplateTextTextColorTextInputStyleTextSearchPathTokenTemplateTokensMethodsFocus()HideSuggestions()OnApplyTemplate()OnPropertyChanged(string)ShowSuggestions()Unfocus()EventsCompletedFilteredItemsChangedSuggestionItemSelectedTextChanged
Not finding the help you need?
Contact Support