Class RadAutoComplete

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

Inheritance

System.Object

RadContentView

RadBorder

RadAutoComplete

Inherited Members

RadBorder.BorderColorProperty

RadBorder.CornerRadiusProperty

RadBorder.BorderThicknessProperty

RadBorder.BorderBrushProperty

RadBorder.ChangeVisualState()

RadBorder.BorderColor

RadBorder.CornerRadius

RadBorder.BorderThickness

RadBorder.BorderBrush

RadBorder.IRadBorder.BorderBrush

RadContentView.ActualStyleClassProperty

RadContentView.OnChildAdded(Element)

RadContentView.OnChildRemoved(Element, Int32)

RadContentView.OnBindingContextChanged()

RadContentView.ActualStyleClass

Namespace: Telerik.Maui.Controls

Assembly: Telerik.Maui.Controls.dll

Syntax

public class RadAutoComplete : RadBorder, IRadBorder, IRadContentView, IContentView, IView, IElement, ITransform, IPadding

Constructors

RadAutoComplete()

Declaration

public RadAutoComplete()

Fields

ActualClearButtonStyleProperty

Identifies the ActualClearButtonStyle property.

Declaration

public static readonly BindableProperty ActualClearButtonStyleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

BackgroundColorProperty

Identifies the BackgroundColor property.

Declaration

public static readonly BindableProperty BackgroundColorProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ClearButtonStyleProperty

Identifies the ClearButtonStyle property.

Declaration

public static readonly BindableProperty ClearButtonStyleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

CompletionModeProperty

Identifies the CompletionMode property.

Declaration

public static readonly BindableProperty CompletionModeProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

DisplayModeProperty

Identifies the DisplayMode property.

Declaration

public static readonly BindableProperty DisplayModeProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

DisplayTextFormatterProperty

Identifies the DisplayTextFormatter property.

Declaration

public static readonly BindableProperty DisplayTextFormatterProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

FilteredItemsProperty

Identifies the FilteredItems property.

Declaration

public static readonly BindableProperty FilteredItemsProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

FilterProperty

Identifies the Filter property.

Declaration

public static readonly BindableProperty FilterProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

FocusedBorderBrushProperty

Identifies the FocusedBorderBrush property.

Declaration

public static readonly BindableProperty FocusedBorderBrushProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

FontAttributesProperty

Identifies the FontAttributes property.

Declaration

public static readonly BindableProperty FontAttributesProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

FontFamilyProperty

Identifies the FontFamily property.

Declaration

public static readonly BindableProperty FontFamilyProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

FontSizeProperty

Identifies the FontSize property.

Declaration

public static readonly BindableProperty FontSizeProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

IsClearButtonVisibleProperty

Identifies the IsClearButtonVisible property.

Declaration

public static readonly BindableProperty IsClearButtonVisibleProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ItemsSourceProperty

Identifies the ItemsSource property.

Declaration

public static readonly BindableProperty ItemsSourceProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

KeyboardProperty

Identifies the Keyboard property.

Declaration

public static readonly BindableProperty KeyboardProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

LoadingTemplateProperty

Identifies the LoadingTemplate property.

Declaration

public static readonly BindableProperty LoadingTemplateProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

NoResultsMessageProperty

Identifies the NoResultsMessage property.

Declaration

public static readonly BindableProperty NoResultsMessageProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

NoResultsTemplateProperty

Identifies the NoResultsTemplate property.

Declaration

public static readonly BindableProperty NoResultsTemplateProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

PlaceholderColorProperty

Identifies the PlaceholderColor property.

Declaration

public static readonly BindableProperty PlaceholderColorProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

PlaceholderProperty

Identifies the Placeholder property.

Declaration

public static readonly BindableProperty PlaceholderProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SearchTextProperty

Identifies the SearchText property.

Declaration

public static readonly BindableProperty SearchTextProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SearchThresholdProperty

Identifies the SearchThreshold property.

Declaration

public static readonly BindableProperty SearchThresholdProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ShowMoreItemsProperty

Identifies the ShowMoreItems property.

Declaration

public static readonly BindableProperty ShowMoreItemsProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ShowMoreTemplateProperty

Identifies the ShowMoreTemplate property.

Declaration

public static readonly BindableProperty ShowMoreTemplateProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ShowSuggestionViewProperty

Identifies the ShowSuggestionView property.

Declaration

public static readonly BindableProperty ShowSuggestionViewProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SuggestionItemHighlightTextColorProperty

Identifies the SuggestionItemHighlightTextColor property.

Declaration

public static readonly BindableProperty SuggestionItemHighlightTextColorProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SuggestionItemTemplateProperty

Identifies the SuggestionItemTemplate property.

Declaration

public static readonly BindableProperty SuggestionItemTemplateProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SuggestionViewBackgroundColorProperty

Identifies the SuggestionViewBackgroundColor property.

Declaration

public static readonly BindableProperty SuggestionViewBackgroundColorProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SuggestionViewBorderColorProperty

Identifies the SuggestionViewBorderColor property.

Declaration

public static readonly BindableProperty SuggestionViewBorderColorProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SuggestionViewBorderThicknessProperty

Identifies the SuggestionViewBorderThickness property.

Declaration

public static readonly BindableProperty SuggestionViewBorderThicknessProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SuggestionViewCornerRadiusProperty

Identifies the SuggestionViewCornerRadius property.

Declaration

public static readonly BindableProperty SuggestionViewCornerRadiusProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SuggestionViewHeightProperty

Identifies the SuggestionViewHeight property.

Declaration

public static readonly BindableProperty SuggestionViewHeightProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SuggestionViewMaxHeightProperty

Identifies the SuggestionViewMaxHeight property.

Declaration

public static readonly BindableProperty SuggestionViewMaxHeightProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SuggestionViewPositionProperty

Identifies the SuggestionViewPosition property.

Declaration

public static readonly BindableProperty SuggestionViewPositionProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SuggestionViewTemplateProperty

Identifies the SuggestionViewTemplate property.

Declaration

public static readonly BindableProperty SuggestionViewTemplateProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SuggestModeProperty

Identifies the SuggestMode property.

Declaration

public static readonly BindableProperty SuggestModeProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TextColorProperty

Identifies the TextColor property.

Declaration

public static readonly BindableProperty TextColorProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TextProperty

Identifies the Text property.

Declaration

public static readonly BindableProperty TextProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TextSearchPathProperty

Identifies the TextSearchPath property.

Declaration

public static readonly BindableProperty TextSearchPathProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TokensProperty

Identifies the Tokens property.

Declaration

public static readonly BindableProperty TokensProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TokenTemplateProperty

Identifies the TokenTemplate property.

Declaration

public static readonly BindableProperty TokenTemplateProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

Properties

ActualClearButtonStyle

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

Declaration

public Style ActualClearButtonStyle { get; }

Property Value

Microsoft.Maui.Controls.Style

BackgroundColor

Declaration

public Color BackgroundColor { get; set; }

Property Value

Microsoft.Maui.Graphics.Color

ClearButtonStyle

Gets or sets the Style of the clear button.

Declaration

public Style ClearButtonStyle { get; set; }

Property Value

Microsoft.Maui.Controls.Style

CompletionMode

Gets or sets the AutoCompleteCompletionMode of the component.

Declaration

public AutoCompleteCompletionMode CompletionMode { get; set; }

Property Value

AutoCompleteCompletionMode

DisplayMode

Gets or sets the AutoCompleteDisplayMode of the component.

Declaration

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

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

public IAutoCompleteFilter Filter { get; set; }

Property Value

IAutoCompleteFilter

FilteredItems

Gets the FilteredItems of the component.

Declaration

public IEnumerable FilteredItems { get; }

Property Value

System.Collections.IEnumerable

FocusedBorderBrush

Gets or sets the color of the border when the control is focused.

Declaration

public Brush FocusedBorderBrush { get; set; }

Property Value

Microsoft.Maui.Controls.Brush

FontAttributes

Gets or sets the FontAttributes of the component.

Declaration

public FontAttributes FontAttributes { get; set; }

Property Value

Microsoft.Maui.Controls.FontAttributes

FontFamily

Gets or sets the FontFamily of the component.

Declaration

public string FontFamily { get; set; }

Property Value

System.String

FontSize

Gets or sets the FontSize of the component.

Declaration

public double FontSize { get; set; }

Property Value

System.Double

IsClearButtonVisible

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

Declaration

public bool IsClearButtonVisible { get; set; }

Property Value

System.Boolean

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

public IEnumerable ItemsSource { get; set; }

Property Value

System.Collections.IEnumerable

Keyboard

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

Declaration

public Keyboard Keyboard { get; set; }

Property Value

Microsoft.Maui.Keyboard

LoadingTemplate

Gets or sets the loading message.

Declaration

public DataTemplate LoadingTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplate

NoResultsMessage

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

Declaration

public string NoResultsMessage { get; set; }

Property Value

System.String

NoResultsTemplate

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

Declaration

public DataTemplate NoResultsTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplate

Placeholder

Gets or sets the placeholder text of the component.

Declaration

public string Placeholder { get; set; }

Property Value

System.String

PlaceholderColor

Gets or sets the placeholder color of the component.

Declaration

public Color PlaceholderColor { get; set; }

Property Value

Microsoft.Maui.Graphics.Color The Color.

SearchText

Gets the search Text.

Declaration

public string SearchText { get; }

Property Value

System.String

SearchThreshold

Gets or sets the SearchThreshold of the component.

Declaration

public int SearchThreshold { get; set; }

Property Value

System.Int32

ShowMoreItems

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

Declaration

public bool ShowMoreItems { get; set; }

Property Value

System.Boolean

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

public DataTemplate ShowMoreTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplate

ShowSuggestionView

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

Declaration

public bool ShowSuggestionView { get; set; }

Property Value

System.Boolean

SuggestionItemHighlightTextColor

Gets or sets the SuggestionItemHighlightTextColor of the component.

Declaration

public Color SuggestionItemHighlightTextColor { get; set; }

Property Value

Microsoft.Maui.Graphics.Color

SuggestionItemTemplate

Gets or sets the SuggestionItemTemplate of the component.

Declaration

public DataTemplate SuggestionItemTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplate

SuggestionViewBackgroundColor

Gets or sets the SuggestionViewBackgroundColor of the component.

Declaration

public Color SuggestionViewBackgroundColor { get; set; }

Property Value

Microsoft.Maui.Graphics.Color

SuggestionViewBorderColor

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

Declaration

public Color SuggestionViewBorderColor { get; set; }

Property Value

Microsoft.Maui.Graphics.Color

SuggestionViewBorderThickness

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

Declaration

public Thickness SuggestionViewBorderThickness { get; set; }

Property Value

Microsoft.Maui.Thickness

SuggestionViewCornerRadius

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

Declaration

public Thickness SuggestionViewCornerRadius { get; set; }

Property Value

Microsoft.Maui.Thickness

SuggestionViewHeight

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

Declaration

public double SuggestionViewHeight { get; set; }

Property Value

System.Double The required SuggestionView height.

SuggestionViewMaxHeight

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

Declaration

public double SuggestionViewMaxHeight { get; set; }

Property Value

System.Double The required SuggestionView max height.

SuggestionViewPosition

Gets or sets the Position for the suggestion view popup.

Declaration

public AutoCompletePopupPosition SuggestionViewPosition { get; set; }

Property Value

AutoCompletePopupPosition

SuggestionViewTemplate

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

Declaration

public DataTemplate SuggestionViewTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplate

SuggestMode

Gets or sets the AutoCompleteSuggestMode of the component.

Declaration

public AutoCompleteSuggestMode SuggestMode { get; set; }

Property Value

AutoCompleteSuggestMode The AutoCompleteSuggestMode.

Text

Gets the visualized Text.

Declaration

public string Text { get; set; }

Property Value

System.String

TextColor

Gets or sets the TextColor of the component.

Declaration

public Color TextColor { get; set; }

Property Value

Microsoft.Maui.Graphics.Color The Color.

TextSearchPath

Gets or sets the TextSearchPath of the component.

Declaration

public string TextSearchPath { get; set; }

Property Value

System.String The TextSearchPath.

Tokens

Gets the available Tokens.

Declaration

public ObservableCollection<object> Tokens { get; }

Property Value

System.Collections.ObjectModel.ObservableCollection<System.Object>

TokenTemplate

Gets or sets the template used to visualize tokens.

Declaration

public DataTemplate TokenTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplate The SuggestionItemTemplate.

Methods

HideSuggestions()

Hides suggestions.

Declaration

public void HideSuggestions()

OnHandlerChanged()

Declaration

protected override void OnHandlerChanged()

Overrides

RadContentView.OnHandlerChanged()

OnPropertyChanged(String)

Declaration

protected override void OnPropertyChanged(string propertyName = null)

Parameters

System.String propertyName

ShowSuggestions()

Shows suggestions.

Declaration

public void ShowSuggestions()

Events

Completed

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

Declaration

public event EventHandler Completed

Event Type

System.EventHandler

FilteredItemsChanged

Occurs when the FilteredItems collection is changed.

Declaration

public event EventHandler<FilteredItemsChangedEventArgs> FilteredItemsChanged

Event Type

System.EventHandler<FilteredItemsChangedEventArgs>

SuggestionItemSelected

Occurs when a suggestion is selected.

Declaration

public event EventHandler<SuggestionItemSelectedEventArgs> SuggestionItemSelected

Event Type

System.EventHandler<SuggestionItemSelectedEventArgs>

TextChanged

Occurs when the text is changed.

Declaration

public event EventHandler<TextChangedEventArgs> TextChanged

Event Type

System.EventHandler<Microsoft.Maui.Controls.TextChangedEventArgs>

Extension Methods

AndroidTypeConversionExtensions.ToJavaObject(Object)