Class SfAutoComplete

Represents a control that allows the user to enter text with additional functionality that offering suggestions as user type.

Inheritance

System.Object

SfAutoComplete

Namespace: Syncfusion.SfAutoComplete.XForms

Assembly: Syncfusion.SfAutoComplete.XForms.dll

Syntax

public class SfAutoComplete : View, IParentThemeElement, IThemeElement, IDropDownView, IAutoComplete

Constructors

SfAutoComplete()

Initializes a new instance of the SfAutoComplete class.

Declaration

public SfAutoComplete()

Fields

AllowSelectionOnKeyNavigationProperty

Identifies the AllowSelectionOnKeyNavigation bindable property. This property indicates whether the text changed or not, while navigate the suggestion box item using down arrow. It only work for UWP platform.

Declaration

public static readonly BindableProperty AllowSelectionOnKeyNavigationProperty

Field Value

Type
Xamarin.Forms.BindableProperty

AutoCompleteModeProperty

Identifies the AutoCompleteMode bindable property. This property can be used to change mode of AutoComplete in SfAutoComplete.

Declaration

public static readonly BindableProperty AutoCompleteModeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

AutoCompleteSourceProperty

Identifies the AutoCompleteSource bindable property. You can give the AutocompleteSource in the SfAutoComplete control.

Declaration

public static readonly BindableProperty AutoCompleteSourceProperty

Field Value

Type
Xamarin.Forms.BindableProperty

BorderColorProperty

Identifies the BorderColor bindable property. This property can be used to change the color of border of the input field.

Declaration

public static readonly BindableProperty BorderColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ClearButtonColorProperty

Identifies the ClearButtonColor bindable property. This property can be used to change the color of the clear button.

Declaration

public static readonly BindableProperty ClearButtonColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DataSourceProperty

Identifies the DataSource bindable property. It is responsible for populating this view.

Declaration

public static readonly BindableProperty DataSourceProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DelimiterProperty

Identifies the FilteredItems bindable property. It is a sequence of one or more characters used to specify the boundary between separate and independent regions in data streams.

Declaration

public static readonly BindableProperty DelimiterProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DisplayMemberPathProperty

Identifies the DisplayMemberPath bindable property. It is a display member path used to search suggestions.

Declaration

public static readonly BindableProperty DisplayMemberPathProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownBackgroundColorProperty

Identifies the DropDownBackgroundColor bindable property. This property can be used to set the background color of drop-down.

Declaration

public static readonly BindableProperty DropDownBackgroundColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownBorderColorProperty

Identifies the DropDownBorderColor bindable property. This property can be used to change the color of border of the drop down.

Declaration

public static readonly BindableProperty DropDownBorderColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownCornerRadiusProperty

Identifies the DropDownCornerRadius bindable property. This property can be used to show the covered dropDown.

Declaration

public static readonly BindableProperty DropDownCornerRadiusProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownFontAttributesProperty

Identifies the DropDownFontAttributes bindable property. This property is used to give the font attributes of available suggestion items in the drop-down.

Declaration

public static readonly BindableProperty DropDownFontAttributesProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownFooterViewHeightProperty

Identifies the ShowDropDownHeaderView bindable property. This property can be used to customize the height of footer in drop-down.

Declaration

public static readonly BindableProperty DropDownFooterViewHeightProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownFooterViewProperty

Identifies the ShowDropDownHeaderView bindable property. This property can be used to customize the header of drop-down.

Declaration

public static readonly BindableProperty DropDownFooterViewProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownHeaderViewHeightProperty

Identifies the DropDownHeaderViewHeight bindable property. This property can be used to customize the height of the drop-down header view.

Declaration

public static readonly BindableProperty DropDownHeaderViewHeightProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownHeaderViewProperty

Identifies the DropDownHeaderView bindable property. This property can be used to customize the header of drop-down.

Declaration

public static readonly BindableProperty DropDownHeaderViewProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownItemFontAttributesProperty

Identifies the DropDownItemFontAttributes bindable property. This property can be used to change the font attributes of available suggestion items in the drop-down.

Declaration

public static readonly BindableProperty DropDownItemFontAttributesProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownItemFontFamilyProperty

Identifies the DropDownItemFontFamily bindable property. It is used to change the font family of available suggestion items in the drop-down.

Declaration

public static readonly BindableProperty DropDownItemFontFamilyProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownItemHeightProperty

Identifies the DropDownItemHeight bindable property. This property can be used to change the height of drop-down that holds the available suggestion items.

Declaration

public static readonly BindableProperty DropDownItemHeightProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownTextColorProperty

Identifies the DropDownTextColor bindable property. This property can be used to change text color of suggestion items.

Declaration

public static readonly BindableProperty DropDownTextColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownTextSizeProperty

Identifies the DropDownTextSize bindable property. This property can be used to change the text size of the available suggestion items in the drop-down.

Declaration

public static readonly BindableProperty DropDownTextSizeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

DropDownWidthProperty

Using a DependencyProperty as the backing store for PopupDelay property.

Declaration

public static readonly BindableProperty DropDownWidthProperty

Field Value

Type
Xamarin.Forms.BindableProperty

EnableAutoSizeProperty

Identifies the EnableAutoSize bindable property. This property indicates whether the border is visible or not.

Declaration

public static readonly BindableProperty EnableAutoSizeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

EnableSelectionIndicatorProperty

Identifies the EnableSelectionIndicator bindable property. It indicates whether the selection indicator is shown or not in drop-down.

Declaration

public static readonly BindableProperty EnableSelectionIndicatorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FilteredItemsProperty

Identifies the FilteredItems bindable property. This property is used to filter a particular set of items.

Declaration

public static readonly BindableProperty FilteredItemsProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FontAttributesProperty

Identifies the FontAttributes bindable property. This property can be used to change the font attributes for the text in the input field.

Declaration

public static readonly BindableProperty FontAttributesProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FontFamilyProperty

Identifies the FontFamily bindable property. This property can be used to change the font family for the text in the input field.

Declaration

public static readonly BindableProperty FontFamilyProperty

Field Value

Type
Xamarin.Forms.BindableProperty

HighlightedTextColorProperty

Identifies the HighlightedTextColor bindable property. This property can be used to change the text color of the highlighted character.

Declaration

public static readonly BindableProperty HighlightedTextColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

HighlightedTextFontAttributesProperty

Identifies the HighlightedTextColor bindable property. This property can be used to set the font attributes of the MatchingText in the drop-down.

Declaration

public static readonly BindableProperty HighlightedTextFontAttributesProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IgnoreDiacriticProperty

Identifies the IgnoreDiacritic bindable property. This property indicates whether the diacritic is enabled or not in the SfAutoComplete control.

Declaration

public static readonly BindableProperty IgnoreDiacriticProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ImageMemberPathProperty

Identifies the Keyboard bindable property. This property is used to give the member path to an image in the SfAutoComplete control.

Declaration

public static readonly BindableProperty ImageMemberPathProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IndicatorFontFamilyProperty

Identifies the IndicatorFontFamily bindable property. This property can be used to change the fontfamily of indicator.

Declaration

public static readonly BindableProperty IndicatorFontFamilyProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IndicatorTextColorProperty

Identifies the IndicatorFontFamily bindable property. This property can be used to change the color of the indicator's text.

Declaration

public static readonly BindableProperty IndicatorTextColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IndicatorTextProperty

Identifies the IndicatorText bindable property. This property can be used to change the indicator's text.

Declaration

public static readonly BindableProperty IndicatorTextProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IndicatorTextSizeProperty

Identifies the IndicatorFontFamily bindable property. Using property, you can change the size of indicator's text.

Declaration

public static readonly BindableProperty IndicatorTextSizeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IsDropDownOpenProperty

Identifies the IsDropDownOpen bindable property. It indicates whether the dropDown has to be shown are not in the SfAutoComplete control.

Declaration

public static readonly BindableProperty IsDropDownOpenProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IsFocusedProperty

Identifies the IsFocused bindable property. It indicates whether the dropDown has to be shown are not in the SfAutoComplete control.

Declaration

public static readonly BindableProperty IsFocusedProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IsSelectedItemsVisibleInDropDownProperty

Identifies the IsSelectedItemsVisibleInDropDown bindable property. This property indicates whether the selected item is visible or not in drop-down.

Declaration

public static readonly BindableProperty IsSelectedItemsVisibleInDropDownProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ItemPaddingProperty

Identifies the IndicatorFontFamily bindable property. This property can be used to change the padding between items in SfAutoComplete.

Declaration

public static readonly BindableProperty ItemPaddingProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ItemsSourceProperty

Identifies the ItemsSource bindable property. It can be populated as suggestion items and get rendered at run-time based on the Template provided.

Declaration

public static readonly BindableProperty ItemsSourceProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ItemTemplateProperty

Identifies the ItemTemplate bindable property. It is an instance of the Template class that defines the visual structure of a suggestion item.

Declaration

public static readonly BindableProperty ItemTemplateProperty

Field Value

Type
Xamarin.Forms.BindableProperty

KeyboardProperty

Identifies the Keyboard bindable property.

Declaration

public static readonly BindableProperty KeyboardProperty

Field Value

Type
Xamarin.Forms.BindableProperty

LoadMoreTemplateProperty

Identifies the LoadMoreTemplate bindable property. This property can be used to change the LoadMoreTemplate.

Declaration

public static readonly BindableProperty LoadMoreTemplateProperty

Field Value

Type
Xamarin.Forms.BindableProperty

LoadMoreTextProperty

Identifies the LoadMoreText bindable property. This property can be used to change the LoadMoreText.

Declaration

public static readonly BindableProperty LoadMoreTextProperty

Field Value

Type
Xamarin.Forms.BindableProperty

MaximumDropDownHeightProperty

Identifies the DropDownItemHeight bindable property. This property can be used to give the maximum height of drop-down that holds the available suggestion items.

Declaration

public static readonly BindableProperty MaximumDropDownHeightProperty

Field Value

Type
Xamarin.Forms.BindableProperty

MaximumSuggestionProperty

Identifies the MaximumSuggestion bindable property. This property indicates the minimum number of characters to be typed for the drop-down to open.

Declaration

public static readonly BindableProperty MaximumSuggestionProperty

Field Value

Type
Xamarin.Forms.BindableProperty

MinimumPrefixCharactersProperty

Identifies the MinimumPrefixCharacters bindable property. It determines minimum number of characters to be typed for the drop-down to open.

Declaration

public static readonly BindableProperty MinimumPrefixCharactersProperty

Field Value

Type
Xamarin.Forms.BindableProperty

MultiSelectModeProperty

Identifies the MultiSelectMode bindable property. This property can be used to change the multi-selection mode to delimeter, token, or none.

Declaration

public static readonly BindableProperty MultiSelectModeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

NoResultsFoundFontAttributesProperty

Identifies the NoResultsFoundFontAttributes bindable property. This property can be used to change the font attributes for the no results found text.

Declaration

public static readonly BindableProperty NoResultsFoundFontAttributesProperty

Field Value

Type
Xamarin.Forms.BindableProperty

NoResultsFoundFontFamilyProperty

Identifies the NoResultsFoundFontFamily bindable property. This property can be used to change the font family for the no results found text.

Declaration

public static readonly BindableProperty NoResultsFoundFontFamilyProperty

Field Value

Type
Xamarin.Forms.BindableProperty

NoResultsFoundFontSizeProperty

Identifies the NoResultsFoundFontSize bindable property. This property can be used to change the NoResultsFoundFontSize.

Declaration

public static readonly BindableProperty NoResultsFoundFontSizeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

NoResultsFoundTextColorProperty

Identifies the NoResultsFoundTextColor bindable property. This property can be used to change the NoResultsFoundTextColor.

Declaration

public static readonly BindableProperty NoResultsFoundTextColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

NoResultsFoundTextProperty

Identifies the NoResultsFoundText bindable property. This property can be used to change the NoResultsFoundText.

Declaration

public static readonly BindableProperty NoResultsFoundTextProperty

Field Value

Type
Xamarin.Forms.BindableProperty

PopupDelayProperty

Identifies the PopupDelay bindable property. This property can be used to give the delay(milliseconds) to open the suggestion popup.

Declaration

public static readonly BindableProperty PopupDelayProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SearchDelayProperty

Identifies the SearchDelay bindable property. This property can be used to give the delay(milliseconds) to before search algorithm.

Declaration

public static readonly BindableProperty SearchDelayProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SelectAllOnFocusProperty

Identifies the SelectAllOnFocus property. It is used to select value of text box when text box is on the focus state Xamarin.Forms.BindableProperty.

Declaration

public static readonly BindableProperty SelectAllOnFocusProperty

Field Value

Type
Xamarin.Forms.BindableProperty

Remarks

This Xamarin.Forms.BindableProperty is read-only.

SelectedIndexProperty

Identifies the SelectedIndex bindable property. This property can be used to select a particular index of item in SfAutoComplete.

Declaration

public static readonly BindableProperty SelectedIndexProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SelectedIndicesProperty

Identifies the SelectedIndex bindable property. This property can be used to get the selected indexes of selected items.

Declaration

public static readonly BindableProperty SelectedIndicesProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SelectedItemProperty

Identifies the SelectedIndex bindable property. This property can be used to select a particular item in SfAutoComplete.

Declaration

public static readonly BindableProperty SelectedItemProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SelectedValuePathProperty

Identifies the SelectedValuePath bindable property. It is a selected value path, using which SelectedValue is set.

Declaration

public static readonly BindableProperty SelectedValuePathProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SelectedValueProperty

Identifies the SelectedValue bindable property. This property can be used to select a particular item in SfAutoComplete.

Declaration

public static readonly BindableProperty SelectedValueProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SelectionTypeProperty

Identifies the SelectionType bindable property. This property indicates whether the Selection Type is Default or not.

Declaration

public static readonly BindableProperty SelectionTypeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ShowBorderProperty

Identifies the ShowBorder bindable property. This property indicates whether the border is visible or not.

Declaration

public static readonly BindableProperty ShowBorderProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ShowClearButtonProperty

Identifies the ShowClearButton bindable property. This property indicates whether the clear button is visible or not.

Declaration

public static readonly BindableProperty ShowClearButtonProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ShowDropDownFooterViewProperty

Identifies the ShowDropDownFooterView bindable property. This property can be used to customize the footer of drop-down.

Declaration

public static readonly BindableProperty ShowDropDownFooterViewProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ShowDropDownHeaderViewProperty

Identifies the ShowDropDownHeaderView bindable property. This property can be used to change the visiblity of drop-down header view.

Declaration

public static readonly BindableProperty ShowDropDownHeaderViewProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ShowSuggestionsOnFocusProperty

Identifies the ShowSuggestionsOnFocus bindable property. It indicates whether the complete suggestion list should be displayed when an empty input field is focused.

Declaration

public static readonly BindableProperty ShowSuggestionsOnFocusProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SuggestionBoxPlacementProperty

Identifies the SuggestionBoxPlacement bindable property. This property can be used to change the position of suggestion box in SfAutoComplete.

Declaration

public static readonly BindableProperty SuggestionBoxPlacementProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SuggestionModeProperty

Identifies the SuggestionMode bindable property. This property can be used to change the suggestion mode in SfAutoComplete.

Declaration

public static readonly BindableProperty SuggestionModeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

TextColorProperty

Identifies the TextColor bindable property. This property can be used to change the color of text in the input field.

Declaration

public static readonly BindableProperty TextColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

TextHighlightModeProperty

Identifies the TextHighlightMode bindable property. This property can be used to highlight whether the first character or all same character in text.

Declaration

public static readonly BindableProperty TextHighlightModeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

TextProperty

Identifies the Text bindable property. This property can be used to change the text of input field in the SfAutoComplete control.

Declaration

public static readonly BindableProperty TextProperty

Field Value

Type
Xamarin.Forms.BindableProperty

TextSizeProperty

Identifies the TextSize bindable property. This property can be used to change the text size of the input field.

Declaration

public static readonly BindableProperty TextSizeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

TokenSettingsProperty

Identifies the TokenSettingsProperty bindable property. This property can be used to display the hint text when the input field is empty and unfocused.

Declaration

public static readonly BindableProperty TokenSettingsProperty

Field Value

Type
Xamarin.Forms.BindableProperty

TokensWrapModeProperty

Identifies the TokensWrapModeProperty bindable property. This property can be used to change the value to either wrap or none.

Declaration

public static readonly BindableProperty TokensWrapModeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

WatermarkColorProperty

Identifies the WatermarkColor bindable property. This property can be used to change the color of the hint text in the input field.

Declaration

public static readonly BindableProperty WatermarkColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

WatermarkProperty

Identifies the Watermark bindable property. It is used to display hint text when the input field is empty and unfocused.

Declaration

public static readonly BindableProperty WatermarkProperty

Field Value

Type
Xamarin.Forms.BindableProperty

Properties

AllowSelectionOnKeyNavigation

Gets or sets a value indicating whether the text changed or not, while navigate the suggestion box item using down arrow in SfAutoComplete.

Declaration

public bool AllowSelectionOnKeyNavigation { get; set; }

Property Value

Type
System.Boolean

AutoCompleteMode

Gets or sets AutoCompleteMode�that display the�Suggestions in several ways.

Declaration

public AutoCompleteMode AutoCompleteMode { get; set; }

Property Value

Type	Description
AutoCompleteMode	The default value is Suggest.

AutoCompleteSource

Gets or sets the value of AutocompleteSource. You can give the AutocompleteSource in the SfAutoComplete control.

Declaration

public List<string> AutoCompleteSource { get; set; }

Property Value

Type
System.Collections.Generic.List<System.String>

BorderColor

Gets or sets the value of the Border color. This property can be used to change the color of border of the input field.

Declaration

public Color BorderColor { get; set; }

Property Value

Type
Xamarin.Forms.Color

ClearButtonColor

Gets or sets the value of the color. This property can be used to change the color of the clear button.

Declaration

public Color ClearButtonColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The default value is Gray.

DataSource

Gets or sets the DataSource of SfAutoComplete control.

Declaration

public IEnumerable<object> DataSource { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.Object>	The default value is null.

Delimiter

Gets or sets the value of Delimiter. It is a sequence of one or more characters used to specify the boundary between separate and independent regions in data streams.

Declaration

public string Delimiter { get; set; }

Property Value

Type	Description
System.String	The default value is ",".

DisplayMemberPath

Gets or sets the value of DisplayMemberPath. It is a display member path used to search suggestions.

Declaration

public string DisplayMemberPath { get; set; }

Property Value

Type	Description
System.String	The default value is null.

DropDownBackgroundColor

Gets or sets the value of DropDownBackgroundColor. This property can be used to set the background color of drop-down.

Declaration

public Color DropDownBackgroundColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The color of the drop down background is white.

DropDownBorderColor

Gets or sets the value of the drop down border color. This property can be used to change the color of border of the drop down.

Declaration

public Color DropDownBorderColor { get; set; }

Property Value

Type
Xamarin.Forms.Color

DropDownCornerRadius

Gets or sets the value of DropDownCornerRadius. This property can be used to show the covered dropDown.

Declaration

public double DropDownCornerRadius { get; set; }

Property Value

Type	Description
System.Double	The default value is 5.

DropDownFontAttributes

Gets or sets the value of DropDownFontAttributes. This property is used to give the font attributes of the available suggestion items in the drop-down.

Declaration

public FontAttributes DropDownFontAttributes { get; set; }

Property Value

Type	Description
Xamarin.Forms.FontAttributes	The default value is Xamarin.Forms.FontAttributes.None.

DropDownFooterView

Gets or sets the value of the DropDownFooterView. This property can be used to customize the footer of drop down.

Declaration

public View DropDownFooterView { get; set; }

Property Value

Type	Description
Xamarin.Forms.View	The default value is null.

DropDownFooterViewHeight

Gets or sets the value of DropDownFooterViewHeight. This property can be used to customize the height of footer in drop-down.

Declaration

public double DropDownFooterViewHeight { get; set; }

Property Value

Type	Description
System.Double	The default value is string.Empty.

DropDownHeaderView

Gets or sets the value of the DropDownHeaderView. This property can be used to customize the header of drop-down.

Declaration

public View DropDownHeaderView { get; set; }

Property Value

Type	Description
Xamarin.Forms.View	The default value is null.

DropDownHeaderViewHeight

Gets or sets the value of the DropDownHeaderViewHeight. This property can be used to customize the height of the drop-down header view.

Declaration

public double DropDownHeaderViewHeight { get; set; }

Property Value

Type	Description
System.Double	The default value is 30.

DropDownItemFontAttributes

Gets or sets the value of the DropDownItemFontAttributes. This property can be used to change the font attributes of the available suggestion items in the drop-down.

Declaration

public FontAttributes DropDownItemFontAttributes { get; set; }

Property Value

Type	Description
Xamarin.Forms.FontAttributes	The default value is Xamarin.Forms.FontAttributes.None.

DropDownItemFontFamily

Gets or sets the value of DropDownItemFontFamily. It is used to change the font family of available suggestion items in the drop-down.

Declaration

public string DropDownItemFontFamily { get; set; }

Property Value

Type	Description
System.String	The default value is Xamarin.Forms.FontAttributes.None.

DropDownItemHeight

Gets or sets the value of the DropDownItemHeight. This property can be used to change the height of drop-down that holds the available suggestion items.

Declaration

public double DropDownItemHeight { get; set; }

Property Value

Type	Description
System.Double	The default value is 30.

DropDownTextColor

Gets or sets the value of DropDownTextColor. This property can be used to change text color of suggestion items.

Declaration

public Color DropDownTextColor { get; set; }

Property Value

Type
Xamarin.Forms.Color

DropDownTextSize

Gets or sets the value of the DropDownTextSize. This property can be used to change the text size of the available suggestion items in the drop-down.

Declaration

public double DropDownTextSize { get; set; }

Property Value

Type	Description
System.Double	The default value is 18.

DropDownWidth

Gets or sets the delay(milliseconds) to open the suggestion popup.

Declaration

public int DropDownWidth { get; set; }

Property Value

Type	Description
System.Int32	The default value is 100 milliseconds.

EnableAutoSize

Gets or sets a value indicating whether the auto size is enabled or not in SfAutoComplete.

Declaration

public bool EnableAutoSize { get; set; }

Property Value

Type	Description
System.Boolean	`true` if show border; otherwise, `false`.

EnableSelectionIndicator

Gets or sets a value indicating whether the selection indicator is shown or not in dropdown in SfAutoComplete.

Declaration

public bool EnableSelectionIndicator { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false.

Filter

Gets or sets the Suggestion Predicate Filter.

Declaration

public SfAutoComplete.SuggestionPredicate<object> Filter { get; set; }

Property Value

Type
SfAutoComplete.SuggestionPredicate<System.Object>

FilteredItems

Gets or sets the FilteredItems of the SfAutoComplete control.

Declaration

public IEnumerable<object> FilteredItems { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.Object>	The default value is null.

FontAttributes

Gets or sets the value of FontAttributes. This property can be used to change the font attributes for the text in the input field.

Declaration

public FontAttributes FontAttributes { get; set; }

Property Value

Type	Description
Xamarin.Forms.FontAttributes	The default value is Xamarin.Forms.FontAttributes.None.

FontFamily

Gets or sets the value of FontFamily. This property can be used to change the font family for the text in the input field.

Declaration

public string FontFamily { get; set; }

Property Value

Type	Description
System.String	The default value is Xamarin.Forms.FontAttributes.None.

HighlightedTextColor

Gets or sets the value of the HighlightedTextColor. This property can be used to change the text color of highlighted character.

Declaration

public Color HighlightedTextColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The default value is Blue.

HighlightedTextFontAttributes

Gets or sets the value of HighlightedTextFontAttributes. This property can be used to set the font attributes of the MatchingText in the drop-down.

Declaration

public FontAttributes HighlightedTextFontAttributes { get; set; }

Property Value

Type	Description
Xamarin.Forms.FontAttributes	The default value is Xamarin.Forms.FontAttributes.None.

IgnoreDiacritic

Gets or sets a value indicating whether the diacritic is enabled or not in the SfAutoComplete control.

Declaration

public bool IgnoreDiacritic { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false.

ImageMemberPath

Gets or sets the value of the ImageMemberPath. This property is used to give the member path to an image in the SfAutoComplete control.

Declaration

public string ImageMemberPath { get; set; }

Property Value

Type	Description
System.String	The default value is null.

IndicatorFontFamily

Gets or sets the value of the IndicatorFontFamily. This property can be used to change the fontfamily of indicator.

Declaration

public string IndicatorFontFamily { get; set; }

Property Value

Type	Description
System.String	The Indicator Family .

IndicatorText

Gets or sets the value of the IndicatorText. This property can be used to change the indicator's text.

Declaration

public string IndicatorText { get; set; }

Property Value

Type	Description
System.String	The Indicator Text.

IndicatorTextColor

Gets or sets the value of the IndicatorTextColor. This property can be used to change the color of the indicator's text.

Declaration

public Color IndicatorTextColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The color of the IndicatorText is blue.

IndicatorTextSize

Gets or sets the value of the IndicatorTextSize. Using property, you can change the size of indicator's text.

Declaration

public double IndicatorTextSize { get; set; }

Property Value

Type	Description
System.Double	The default value is 20.

IsDropDownOpen

Gets or sets a value indicating whether the dropDown has to be shown are not in the SfAutoComplete control.

Declaration

public bool IsDropDownOpen { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false.

IsFocused

Gets or sets a value indicating whether the dropDown has to be shown are not in the SfAutoComplete control.

Declaration

public bool IsFocused { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false.

IsSelectedItemsVisibleInDropDown

Gets or sets a value indicating whether the selected item is visible or not in drop-down of SfAutoComplete.

Declaration

public bool IsSelectedItemsVisibleInDropDown { get; set; }

Property Value

Type	Description
System.Boolean	`true` if is selected item visible in drop down; otherwise, `false`.

ItemPadding

Gets or sets the value of ItemPadding. This property can be used to change the padding between items in SfAutoComplete.

Declaration

public Thickness ItemPadding { get; set; }

Property Value

Type	Description
Xamarin.Forms.Thickness	The default value is (10,0,0,0).

ItemsSource

Gets or sets a collection of items that can be populated as suggestion items and rendered at run-time based on the template provided.

Declaration

public object ItemsSource { get; set; }

Property Value

Type	Description
System.Object	The default value is null.

ItemTemplate

Gets or sets an instance of the Template class that defines the visual structure of suggestion items.

Declaration

public DataTemplate ItemTemplate { get; set; }

Property Value

Type
Xamarin.Forms.DataTemplate

Keyboard

Gets or sets the value of the keyboard.

Declaration

public Keyboard Keyboard { get; set; }

Property Value

Type	Description
Xamarin.Forms.Keyboard	The keyboard.

LoadMoreTemplate

Gets or sets the value of LoadMoreTemplate. This property can be used to set the LoadMoreTemplate.

Declaration

public View LoadMoreTemplate { get; set; }

Property Value

Type	Description
Xamarin.Forms.View	The load more text.

LoadMoreText

Gets or sets the value of LoadMoreText. This property can be used to change the LoadMoreText.

Declaration

public string LoadMoreText { get; set; }

Property Value

Type	Description
System.String	The load more text.

MaximumDropDownHeight

Gets or sets the value of the MaximumDropDownHeight. This property can be used to give the maximum height of drop-down that holds the available suggestion items.

Declaration

public int MaximumDropDownHeight { get; set; }

Property Value

Type	Description
System.Int32	The default value is 400.

MaximumSuggestion

Gets or sets the vaule of MaximumSuggestion. This property indicates the minimum number of characters to be typed for the drop-down to open.

Declaration

public int MaximumSuggestion { get; set; }

Property Value

Type
System.Int32

MinimumPrefixCharacters

Gets or sets the value of the MinimumPrefixCharacters. It determines minimum number of characters to be typed for the drop-down to open.

Declaration

public int MinimumPrefixCharacters { get; set; }

Property Value

Type
System.Int32

MultiSelectMode

Gets or sets MultiSelectMode. This property can be used to change the multi-selection mode to delimeter, token, or none.

Declaration

public MultiSelectMode MultiSelectMode { get; set; }

Property Value

Type	Description
MultiSelectMode	The default multi select mode is none.

NoResultsFoundFontAttributes

Gets or sets the value of NoResultsFoundFontAttributes. This property can be used to change the font attributes for the no results found text.

Declaration

public FontAttributes NoResultsFoundFontAttributes { get; set; }

Property Value

Type
Xamarin.Forms.FontAttributes

NoResultsFoundFontFamily

Gets or sets the value of NoResultsFoundFontFamily. This property can be used to change the font family for the no results found text.

Declaration

public string NoResultsFoundFontFamily { get; set; }

Property Value

Type	Description
System.String	The default value is Xamarin.Forms.FontAttributes.None.

NoResultsFoundFontSize

Gets or sets the value of NoResultsFoundFontSize. This property can be used to change the NoResultsFoundFontSize.

Declaration

public double NoResultsFoundFontSize { get; set; }

Property Value

Type	Description
System.Double	The no results found font size.

NoResultsFoundText

Gets or sets the value of NoResultsFoundText. This property can be used to change the NoResultsFoundText.

Declaration

public string NoResultsFoundText { get; set; }

Property Value

Type	Description
System.String	The no results found text.

NoResultsFoundTextColor

Gets or sets the value of NoResultsFoundTextColor. This property can be used to change the NoResultsFoundTextColor.

Declaration

public Color NoResultsFoundTextColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The no results found text color.

PopupDelay

Gets or sets the value of the PopupDelay. This property can be used to give the delay(milliseconds) to open the suggestion popup.

Declaration

public int PopupDelay { get; set; }

Property Value

Type	Description
System.Int32	The default value is 100 milliseconds.

SearchDelay

Gets or sets the value of the SearchDelay. This property can be used to give the delay(milliseconds) before search algorithm.

Declaration

public int SearchDelay { get; set; }

Property Value

Type	Description
System.Int32	The default value is 0 milliseconds.

SelectAllOnFocus

Gets or sets a value indicating whether the text of text box is select all in focus state or not.

Declaration

public bool SelectAllOnFocus { get; set; }

Property Value

Type	Description
System.Boolean	default value is false.

SelectedIndex

Gets or sets the value of SelectedIndex. This property can be used to select a particular index of item in SfAutoComplete.

Declaration

public int SelectedIndex { get; set; }

Property Value

Type	Description
System.Int32	The default value is -1.

SelectedIndices

Gets or sets the value of SelectedIndices. This property can be used to get the selected indexes of selected items.

Declaration

public object SelectedIndices { get; set; }

Property Value

Type	Description
System.Object	The default value is -1.

SelectedItem

Gets or sets the value of the SelectedItem. This property can be used to select a particular item in SfAutoComplete.

Declaration

public object SelectedItem { get; set; }

Property Value

Type	Description
System.Object	The default value is null.

SelectedValue

Gets or sets the value of SelectedValue. This property can be used to select a particular item in SfAutoComplete.

Declaration

public object SelectedValue { get; set; }

Property Value

Type	Description
System.Object	The default value is null.

SelectedValuePath

Gets or sets the selected value path, using which SelectedValue is set in the SfAutoComplete control.

Declaration

public string SelectedValuePath { get; set; }

Property Value

Type	Description
System.String	The default value is null.

SelectionType

Gets or sets a Selection type.

Declaration

public SelectionType SelectionType { get; set; }

Property Value

Type	Description
SelectionType	The default value is AutoSelect.

ShowBorder

Gets or sets a value indicating whether the border is visible or not in SfAutoComplete.

Declaration

public bool ShowBorder { get; set; }

Property Value

Type	Description
System.Boolean	`true` if show border; otherwise, `false`.

ShowClearButton

Gets or sets a value indicating whether the clear button is visible or not in SfAutoComplete.

Declaration

public bool ShowClearButton { get; set; }

Property Value

Type	Description
System.Boolean	`true` if is clear button visible; otherwise, `false`.

ShowDropDownFooterView

Gets or sets a value indicating whether the drop-down footer view is shown or not in SfAutoComplete.

Declaration

public bool ShowDropDownFooterView { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true.

ShowDropDownHeaderView

Gets or sets a value indicating whether the drop-down header view is shown or not in SfAutoComplete.

Declaration

public bool ShowDropDownHeaderView { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true.

ShowSuggestionsOnFocus

Gets or sets a value indicating whether the complete suggestion list should be displayed when an empty input field got focused.

Declaration

public bool ShowSuggestionsOnFocus { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false.

SuggestionBoxPlacement

Gets or sets the SuggestionBoxPlacement�to postion the suggestions box.

Declaration

public SuggestionBoxPlacement SuggestionBoxPlacement { get; set; }

Property Value

Type	Description
SuggestionBoxPlacement	The default value is Bottom.

SuggestionMode

Gets or sets the SuggestionMode�to filter the Suggestions.

Declaration

public SuggestionMode SuggestionMode { get; set; }

Property Value

Type	Description
SuggestionMode	The default value is StartsWith.

Text

Gets or sets the value of Text. This property can be used to change the text of input field in the SfAutoComplete control.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	The default value is string.Empty.

TextColor

Gets or sets the value of the color. This property can be used to change the color of text in the input field.

Declaration

public Color TextColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The default value is Black.

TextHighlightMode

Gets or sets the value of TextHighlightMode. This property can be used to highlight whether the first character or all same character in text.

Declaration

public OccurrenceMode TextHighlightMode { get; set; }

Property Value

Type	Description
OccurrenceMode	The default text highlight mode is none.

TokenSettings

Gets or sets the value of TokenSettings. This property can be used to display the hint text when the input field is empty and unfocused.

Declaration

public TokenSettings TokenSettings { get; set; }

Property Value

Type	Description
TokenSettings	The default value is null.

TokensWrapMode

Gets or sets the value of TokensWrapMode. This property can be used to change the value to either wrap or none.

Declaration

public TokensWrapMode TokensWrapMode { get; set; }

Property Value

Type	Description
TokensWrapMode	The default tokens wrap mode is none.

Watermark

Gets or sets the value of the Watermark. This property can be used to display hint text when the input field is empty and unfocused.

Declaration

public string Watermark { get; set; }

Property Value

Type	Description
System.String	The default value is string.Empty.

WatermarkColor

Gets or sets the value of WatermarkColor. This property can be used to change the color of the hint text in the input field.

Declaration

public Color WatermarkColor { get; set; }

Property Value

Type	Description
Xamarin.Forms.Color	The default value is Gray.

Methods

add_Completed(SfAutoComplete.CompletedEventHandler)

Declaration

public void add_Completed(SfAutoComplete.CompletedEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.CompletedEventHandler	value

add_DrawCell(SfAutoComplete.DrawCellEventHandler)

Declaration

public void add_DrawCell(SfAutoComplete.DrawCellEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.DrawCellEventHandler	value

add_FilterCollectionChanged(SfAutoComplete.FilterCollectionEventHandler)

Declaration

public void add_FilterCollectionChanged(SfAutoComplete.FilterCollectionEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.FilterCollectionEventHandler	value

add_FocusChanged(SfAutoComplete.FocusEventHandler)

Declaration

public void add_FocusChanged(SfAutoComplete.FocusEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.FocusEventHandler	value

add_SelectionChanged(SfAutoComplete.SelectionChangedEventHandler)

Declaration

public void add_SelectionChanged(SfAutoComplete.SelectionChangedEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.SelectionChangedEventHandler	value

add_SelectionChanging(SfAutoComplete.SelectionChangingEventHandler)

Declaration

public void add_SelectionChanging(SfAutoComplete.SelectionChangingEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.SelectionChangingEventHandler	value

add_ValueChanged(SfAutoComplete.ValueChangedEventHandler)

Declaration

public void add_ValueChanged(SfAutoComplete.ValueChangedEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.ValueChangedEventHandler	value

Clear()

The clear method is used to remove all items in the SfAutoComplete control.

Declaration

public void Clear()

Focus()

Focus is used to focus items in the SfAutoComplete control.

Declaration

public void Focus()

LoadMore()

Method for load more items in Focus is used to focus items in the SfAutoComplete control.

Declaration

public void LoadMore()

LoadMore(Int32)

Method for load more items in Focus is used to focus items in the SfAutoComplete control.

Declaration

public void LoadMore(int maximumSuggestion)

Parameters

Type	Name	Description
System.Int32	maximumSuggestion	Maximum suggestion.

OnMeasure(Double, Double)

On measure the height and width.

Declaration

protected override SizeRequest OnMeasure(double widthConstraint, double heightConstraint)

Parameters

Type	Name	Description
System.Double	widthConstraint	Width constraint.
System.Double	heightConstraint	Height constraint.

Returns

Type	Description
Xamarin.Forms.SizeRequest	The measure.

remove_Completed(SfAutoComplete.CompletedEventHandler)

Declaration

public void remove_Completed(SfAutoComplete.CompletedEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.CompletedEventHandler	value

remove_DrawCell(SfAutoComplete.DrawCellEventHandler)

Declaration

public void remove_DrawCell(SfAutoComplete.DrawCellEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.DrawCellEventHandler	value

remove_FilterCollectionChanged(SfAutoComplete.FilterCollectionEventHandler)

Declaration

public void remove_FilterCollectionChanged(SfAutoComplete.FilterCollectionEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.FilterCollectionEventHandler	value

remove_FocusChanged(SfAutoComplete.FocusEventHandler)

Declaration

public void remove_FocusChanged(SfAutoComplete.FocusEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.FocusEventHandler	value

remove_SelectionChanged(SfAutoComplete.SelectionChangedEventHandler)

Declaration

public void remove_SelectionChanged(SfAutoComplete.SelectionChangedEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.SelectionChangedEventHandler	value

remove_SelectionChanging(SfAutoComplete.SelectionChangingEventHandler)

Declaration

public void remove_SelectionChanging(SfAutoComplete.SelectionChangingEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.SelectionChangingEventHandler	value

remove_ValueChanged(SfAutoComplete.ValueChangedEventHandler)

Declaration

public void remove_ValueChanged(SfAutoComplete.ValueChangedEventHandler value)

Parameters

Type	Name	Description
SfAutoComplete.ValueChangedEventHandler	value

SetCursorPosition(Int32)

Method to set the position of the cursor in the SfAutoComplete control.

Declaration

public void SetCursorPosition(int position)

Parameters

Type	Name	Description
System.Int32	position	Position.

Events

Completed

This event occurs when users click the Done button in the SfAutoComplete control.

Declaration

public event SfAutoComplete.CompletedEventHandler Completed

Event Type

Type
SfAutoComplete.CompletedEventHandler

DrawCell

This event occurs when each suggestion item is loaded in the SfAutoComplete control.

Declaration

public event SfAutoComplete.DrawCellEventHandler DrawCell

Event Type

Type
SfAutoComplete.DrawCellEventHandler

DropDownClosing

The DropDownClosingEventHandler event occurs when the drop-down is being closed in the control.

Declaration

public event EventHandler<DropDownCancelEventArgs> DropDownClosing

Event Type

Type
System.EventHandler<DropDownCancelEventArgs>

FilterCollectionChanged

The FilterCollectionChanged occurs when filter items in the SfAutoComplete control.

Declaration

public event SfAutoComplete.FilterCollectionEventHandler FilterCollectionChanged

Event Type

Type
SfAutoComplete.FilterCollectionEventHandler

FocusChanged

The FocusChanged event is hooked when focus of the text is changed in the SfAutoComplete control.

Declaration

public event SfAutoComplete.FocusEventHandler FocusChanged

Event Type

Type
SfAutoComplete.FocusEventHandler

LoadMoreButtonTapped

The LoadMoreTappedEventHandler event occurs when the load more is tapped in the SfAutoComplete control.

Declaration

public event EventHandler<EventArgs> LoadMoreButtonTapped

Event Type

Type
System.EventHandler<System.EventArgs>

SelectionChanged

This event occurs when users select an item from unselected items in the SfAutoComplete control.

Declaration

public event SfAutoComplete.SelectionChangedEventHandler SelectionChanged

Event Type

Type
SfAutoComplete.SelectionChangedEventHandler

SelectionChanging

This event occurs when users select an item from unselected items in the SfAutoComplete control.

Declaration

public event SfAutoComplete.SelectionChangingEventHandler SelectionChanging

Event Type

Type
SfAutoComplete.SelectionChangingEventHandler

ValueChanged

This event occurs when users change the input in the SfAutoComplete control.

Declaration

public event SfAutoComplete.ValueChangedEventHandler ValueChanged

Event Type

Type
SfAutoComplete.ValueChangedEventHandler