Class AutocompleteProperties

Inheritance
System.Object
EJTagHelper
AutocompleteProperties
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.JavaScript.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class AutocompleteProperties : EJTagHelper

Constructors

AutocompleteProperties()

Initializes a new instance of the AutocompletePropertiesBuilder class.

Declaration
public AutocompleteProperties()

Properties

ActionBegin

Fires when Autocomplete control search action begin.

Declaration
[JsonProperty("actionBegin")]
public string ActionBegin { get; set; }
Property Value
Type Description
System.String

ActionComplete

Fires when Autocomplete control search action completed.

Declaration
[JsonProperty("actionComplete")]
public string ActionComplete { get; set; }
Property Value
Type Description
System.String

ActionFailure

Triggers when the data requested from AJAX get failed.

Declaration
[JsonProperty("actionFailure")]
public string ActionFailure { get; set; }
Property Value
Type Description
System.String

ActionSuccess

Triggers when the data requested from AJAX will get successfully loaded in the Autocomplete widget.

Declaration
[JsonProperty("actionSuccess")]
public string ActionSuccess { get; set; }
Property Value
Type Description
System.String

AddNewText

Customize “Add New” text (label) to be added in the autocomplete popup list for the entered text when there are no suggestions for it.

Declaration
[JsonProperty("addNewText")]
public string AddNewText { get; set; }
Property Value
Type Description
System.String

AllowAddNew

Allows new values to be added to the autocomplete input other than the values in the suggestion list.

Declaration
[JsonProperty("allowAddNew")]
public bool AllowAddNew { get; set; }
Property Value
Type Description
System.Boolean

AllowGrouping

The allowGrouping property has been deprecated.Use groupBy field instead of allowGrouping

Declaration
[Obsolete("The allowGrouping property has been deprecated.Use groupBy field instead of allowGrouping ")]
[JsonProperty("allowGrouping")]
public bool AllowGrouping { get; set; }
Property Value
Type Description
System.Boolean

AllowSorting

Enables or disables the sorting of suggestion list item. The default sort order is ascending order. We can customize the sort order.

Declaration
[JsonProperty("allowSorting")]
public bool AllowSorting { get; set; }
Property Value
Type Description
System.Boolean

AnimateType

Sets an animate to Autocomplete suggesstion list.

Declaration
[JsonProperty("animateType")]
[JsonConverter(typeof(StringEnumConverter))]
public AnimateTypes AnimateType { get; set; }
Property Value
Type Description
AnimateTypes

AutocompleteFields

Mapping fields for the suggestion items of the Autocomplete textbox widget.

Declaration
[JsonProperty("fields")]
public AutocompleteFields AutocompleteFields { get; set; }
Property Value
Type Description
AutocompleteFields

AutoFocus

To focus the items in the suggestion list when the popup is shown. By default first item will be focused.

Declaration
[JsonProperty("autoFocus")]
public bool AutoFocus { get; set; }
Property Value
Type Description
System.Boolean

CaseSensitiveSearch

Enables or disables the case sensitive search.

Declaration
[JsonProperty("caseSensitiveSearch")]
public bool CaseSensitiveSearch { get; set; }
Property Value
Type Description
System.Boolean

Change

Triggers when the text box value is changed.

Declaration
[JsonProperty("change")]
public string Change { get; set; }
Property Value
Type Description
System.String

Close

Triggers after the suggestion popup is closed.

Declaration
[JsonProperty("close")]
public string Close { get; set; }
Property Value
Type Description
System.String

Create

Triggers when Autocomplete widget is created.

Declaration
[JsonProperty("create")]
public string Create { get; set; }
Property Value
Type Description
System.String

CssClass

The root class for the Autocomplete textbox widget which helps in customizing it's theme.

Declaration
[JsonProperty("cssClass")]
public string CssClass { get; set; }
Property Value
Type Description
System.String

DataSource

The data source contains the list of data for the suggestions list. It can be a string array or json array.

Declaration
[JsonProperty("dataSource")]
[HtmlAttributeName("datasource")]
[JsonConverter(typeof(DataManagerConverter))]
public object DataSource { get; set; }
Property Value
Type Description
System.Object

DelaySuggestionTimeout

The time delay (in milliseconds) after which the suggestion popup will be shown.

Declaration
[JsonProperty("delaySuggestionTimeout")]
public int DelaySuggestionTimeout { get; set; }
Property Value
Type Description
System.Int32

Delimiter

The special character which acts as a separator for the given words for multi-mode search i.e. the text after the delimiter are considered as a separate word or query for search operation.

Declaration
[JsonProperty("delimiterChar")]
public string Delimiter { get; set; }
Property Value
Type Description
System.String

Destroy

Triggers after the Autocomplete widget is destroyed.

Declaration
[JsonProperty("destroy")]
public string Destroy { get; set; }
Property Value
Type Description
System.String

EmptyResultText

The text to be displayed in the popup when there are no suggestions available for the entered text.

Declaration
[JsonProperty("emptyResultText")]
public string EmptyResultText { get; set; }
Property Value
Type Description
System.String

EnableAutoFill

Fills the autocomplete textbox with the first matched item from the suggestion list automatically based on the entered text when enabled.

Declaration
[JsonProperty("enableAutoFill")]
public bool EnableAutoFill { get; set; }
Property Value
Type Description
System.Boolean

Enabled

Enables or disables the Autocomplete textbox widget.

Declaration
[JsonProperty("enabled")]
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean

EnableDistinct

Enables or disables displaying the duplicate names present in the search result.

Declaration
[JsonProperty("enableDistinct")]
public bool EnableDistinct { get; set; }
Property Value
Type Description
System.Boolean

EnablePersistence

Saves the current model value to the browser cookies for maintaining states. On refreshing, the Autocomplete control page retains the model value applied from browser cookies.

Declaration
[JsonProperty("enablePersistence")]
public bool EnablePersistence { get; set; }
Property Value
Type Description
System.Boolean

EnableRTL

Displays the Autocomplete widget’s content from right to left when enabled.

Declaration
[JsonProperty("enableRTL")]
public bool EnableRTL { get; set; }
Property Value
Type Description
System.Boolean

FilterType

Specifies the search filter type. There are several types of search filter available such as ‘startswith’, ‘contains’, ‘endswith’, ‘lessthan’, ‘lessthanorequal’, ‘greaterthan’, ‘greaterthanorequal’, ‘equal’, ‘notequal’.

Declaration
[JsonProperty("filterType")]
[JsonConverter(typeof(StringEnumConverter))]
public FilterOperatorType FilterType { get; set; }
Property Value
Type Description
FilterOperatorType

FocusIn

Triggers after the autocomplete textbox is focused.

Declaration
[JsonProperty("focusIn")]
public string FocusIn { get; set; }
Property Value
Type Description
System.String

FocusOut

Triggers after the Autocomplete textbox gets out of the focus.

Declaration
[JsonProperty("focusOut")]
public string FocusOut { get; set; }
Property Value
Type Description
System.String

Height

The height of the Autocomplete textbox.

Declaration
[JsonProperty("height")]
public string Height { get; set; }
Property Value
Type Description
System.String

HighlightSearch

The search text can be highlighted in the AutoComplete suggestion list when enabled.

Declaration
[JsonProperty("highlightSearch")]
public bool HighlightSearch { get; set; }
Property Value
Type Description
System.Boolean

HtmlAttributes

Mapping Field for HtmlAttribute property.

Declaration
[JsonProperty("htmlAttributes")]
public IDictionary<string, object> HtmlAttributes { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

IgnoreAccent

To enable or disable the diacritic characters of the Autocomplete suggestion list when filtering.

Declaration
[JsonProperty("ignoreAccent")]
public bool IgnoreAccent { get; set; }
Property Value
Type Description
System.Boolean

IsFor

To get or set value for IsFor property.

Declaration
[JsonIgnore]
public bool IsFor { get; set; }
Property Value
Type Description
System.Boolean

ItemsCount

Number of items to be displayed in the suggestion list.

Declaration
[JsonProperty("itemsCount")]
public int ItemsCount { get; set; }
Property Value
Type Description
System.Int32

Locale

Defines the localization culture for the Autocomplete.

Declaration
[JsonProperty("locale")]
public string Locale { get; set; }
Property Value
Type Description
System.String

MinCharacter

Minimum number of character to be entered in the Autocomplete textbox to show the suggestion list.

Declaration
[JsonProperty("minCharacter")]
public int MinCharacter { get; set; }
Property Value
Type Description
System.Int32

MultiColumnSettings

Specifies the column to be displayed in popupList.

Declaration
[JsonProperty("multiColumnSettings")]
public MultiColumnSettings MultiColumnSettings { get; set; }
Property Value
Type Description
MultiColumnSettings

MultiSelectMode

Enables or disables selecting multiple values from the suggestion list.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("multiSelectMode")]
public MultiSelectModeTypes MultiSelectMode { get; set; }
Property Value
Type Description
MultiSelectModeTypes

Name

Specifies the name of the autocomplete.

Declaration
[JsonProperty("name")]
public string Name { get; set; }
Property Value
Type Description
System.String

Open

Triggers after the suggestion list is opened.

Declaration
[JsonProperty("open")]
public string Open { get; set; }
Property Value
Type Description
System.String

PopupHeight

The height of the suggestion list.

Declaration
[JsonProperty("popupHeight")]
public string PopupHeight { get; set; }
Property Value
Type Description
System.String

PopupWidth

The width of the suggestion list.

Declaration
[JsonProperty("popupWidth")]
public string PopupWidth { get; set; }
Property Value
Type Description
System.String

Query

The query to retrieve the data from the data source.

Declaration
[JsonConverter(typeof(QueryConverter))]
[JsonProperty("query")]
public string Query { get; set; }
Property Value
Type Description
System.String

ReadOnly

Indicates that the autocomplete textbox values can only be readable.

Declaration
[JsonProperty("readOnly")]
public bool ReadOnly { get; set; }
Property Value
Type Description
System.Boolean

Select

Triggers when an item has been selected from the suggestion list.

Declaration
[JsonProperty("select")]
public string Select { get; set; }
Property Value
Type Description
System.String

SelectValueByKey

Sets the value for the Autocomplete textbox based on the given input key value.

Declaration
[JsonProperty("selectValueByKey")]
public string SelectValueByKey { get; set; }
Property Value
Type Description
System.String

ShowEmptyResultText

Enables or disables showing the message when there are no suggestions for the entered text.

Declaration
[JsonProperty("showEmptyResultText")]
public bool ShowEmptyResultText { get; set; }
Property Value
Type Description
System.Boolean

ShowLoadingIcon

Enables or disables the loading icon to intimate the searching operation. The loading icon is visible when there is a time delay to perform the search.

Declaration
[JsonProperty("showLoadingIcon")]
public bool ShowLoadingIcon { get; set; }
Property Value
Type Description
System.Boolean

ShowPopupButton

Enables the showPopup button in autocomplete textbox. When the Showpopup button is clicked, it displays all the available data from the data source.

Declaration
[JsonProperty("showPopupButton")]
public bool ShowPopupButton { get; set; }
Property Value
Type Description
System.Boolean

ShowResetIcon

Enables the reset icon while searching

Declaration
[JsonProperty("showResetIcon")]
public bool ShowResetIcon { get; set; }
Property Value
Type Description
System.Boolean

ShowRoundedCorner

Enables or disables the rounded corner.

Declaration
[JsonProperty("showRoundedCorner")]
public bool ShowRoundedCorner { get; set; }
Property Value
Type Description
System.Boolean

SortOrder

Sort order specifies whether the suggestion list values has to be displayed in ascending or descending order.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("sortOrder")]
public SortOrder SortOrder { get; set; }
Property Value
Type Description
SortOrder

Tag

To get or set value for Tag property.

Declaration
[JsonIgnore]
public string Tag { get; set; }
Property Value
Type Description
System.String

Template

The template to display the suggestion list items with customized appearance.

Declaration
[JsonProperty("template")]
public string Template { get; set; }
Property Value
Type Description
System.String

ValidationMessage

The jQuery validation error message to be displayed on form validation.

Declaration
[JsonProperty("validationMessage")]
public Dictionary<string, object> ValidationMessage { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

ValidationRules

The jQuery validation rules for form validation.

Declaration
[JsonProperty("validationRules")]
public Dictionary<string, object> ValidationRules { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.Object>

Value

The value to be displayed in the autocomplete textbox.

Declaration
[JsonProperty("value")]
public string Value { get; set; }
Property Value
Type Description
System.String

Visible

Enables or disables the visibility of the autocomplete textbox.

Declaration
[JsonProperty("visible")]
public bool Visible { get; set; }
Property Value
Type Description
System.Boolean

WatermarkText

The text to be displayed when the value of the autocomplete textbox is empty.

Declaration
[JsonProperty("watermarkText")]
public string WatermarkText { get; set; }
Property Value
Type Description
System.String

Width

The width of the Autocomplete textbox.

Declaration
[JsonProperty("width")]
public string Width { get; set; }
Property Value
Type Description
System.String

Methods

GetControlDetails()

Get the control details

Declaration
protected override object GetControlDetails()
Returns
Type Description
System.Object
Overrides

ShouldSerializeAutocompleteFields()

Should Serialize method for Autocomplete Fields.

Declaration
public bool ShouldSerializeAutocompleteFields()
Returns
Type Description
System.Boolean

ShouldSerializeDataSource()

Should Serialize method for DataSource.

Declaration
public bool ShouldSerializeDataSource()
Returns
Type Description
System.Boolean