Class ComboBox

Inheritance
System.Object
TagHelper
EJTagHelper
ComboBox
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.EJ2.DropDowns
Assembly: Syncfusion.EJ2.dll
Syntax
public class ComboBox : EJTagHelper

Constructors

ComboBox()

Declaration
public ComboBox()

Properties

ActionBegin

Triggers before fetching data from the remote server.

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

ActionComplete

Triggers after data is fetched successfully from the remote server.

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

ActionFailure

Triggers when the data fetch request from the remote server fails.

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

ActionFailureTemplate

Accepts the template and assigns it to the popup list content of the component when the data fetch request from the remote server fails.

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

AllowCustom

Specifies whether the component allows user defined value which does not exist in data source.

Declaration
[HtmlAttributeName("allowCustom")]
public bool AllowCustom { get; set; }
Property Value
Type Description
System.Boolean

AllowFiltering

When allowFiltering is set to true, show the filter bar (search box) of the component. The filter action retrieves matched items through the filtering event based on the characters typed in the search TextBox. If no match is found, the value of the noRecordsTemplate property will be displayed.

Declaration
[HtmlAttributeName("allowFiltering")]
public bool AllowFiltering { get; set; }
Property Value
Type Description
System.Boolean

Autofill

Specifies whether suggest a first matched item in input when searching. No action happens when no matches found.

Declaration
[HtmlAttributeName("autofill")]
public bool Autofill { get; set; }
Property Value
Type Description
System.Boolean

BeforeOpen

Triggers when the popup before opens.

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

Blur

Triggers when focus moves out from the component.

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

Change

Triggers when an item in a popup is selected or when the model value is changed by user. Use change event to Configure the Cascading DropDownList

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

ClassName

Declaration
protected override string ClassName { get; }
Property Value
Type Description
System.String
Overrides

Close

Triggers when the popup is closed.

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

Created

Triggers when the component is created.

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

CssClass

Sets CSS classes to the root element of the component that allows customization of appearance.

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

CustomValueSpecifier

Triggers on set a custom value to this component.

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

DataBound

Triggers when data source is populated in the popup list..

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

DataSource

Accepts the list items either through local or remote service and binds it to the component. It can be an array of JSON Objects or an instance of DataManager.

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

Destroyed

Triggers when the component is destroyed.

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

Enabled

Specifies a value that indicates whether the component is enabled or not.

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

EnablePersistence

Enable or disable persisting component's state between page reloads. If enabled, following list of states will be persisted.

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

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration
[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }
Property Value
Type Description
System.Boolean

Fields

The fields property maps the columns of the data table and binds the data to the component. text - Maps the text column from data table for each list item. value - Maps the value column from data table for each list item. iconCss - Maps the icon class column from data table for each list item. groupBy - Group the list items with it's related items by mapping groupBy field.

Declaration
[HtmlAttributeName("fields")]
public ComboBoxFieldSettings Fields { get; set; }
Property Value
Type Description
ComboBoxFieldSettings

Filtering

Triggers on typing a character in the component.

For more details about the filtering refer to Filtering documentation.

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

FilterType

Determines on which filter type, the component needs to be considered on search action. The FilterType and its supported data types are

Declaration
[HtmlAttributeName("filterType")]
public FilterType FilterType { get; set; }
Property Value
Type Description
FilterType

FloatLabelType

Specifies whether to display the floating label above the input element. Possible values are: Never: The label will never float in the input when the placeholder is available. Always: The floating label will always float above the input. Auto: The floating label will float above the input after focusing or entering a value in the input.

Declaration
[HtmlAttributeName("floatLabelType")]
public FloatLabelType FloatLabelType { get; set; }
Property Value
Type Description
FloatLabelType

Focus

Triggers when the component is focused.

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

FooterTemplate

Accepts the template design and assigns it to the footer container of the popup list.

For more details about the available template options refer to Template documentation.

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

GroupTemplate

Accepts the template design and assigns it to the group headers present in the popup list.

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

HeaderTemplate

Accepts the template design and assigns it to the header container of the popup list.

For more details about the available template options refer to Template documentation.

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

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration
[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }
Property Value
Type Description
System.Object

IgnoreAccent

ignoreAccent set to true, then ignores the diacritic characters or accents when filtering.

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

IgnoreCase

When set to ‘false’, consider the case-sensitive on performing the search to find suggestions. By default consider the casing.

Declaration
[HtmlAttributeName("ignoreCase")]
public bool IgnoreCase { get; set; }
Property Value
Type Description
System.Boolean

Index

Gets or sets the index of the selected item in the component.

Declaration
[HtmlAttributeName("index")]
public double Index { get; set; }
Property Value
Type Description
System.Double

IsFor

Declaration
protected override bool IsFor { get; }
Property Value
Type Description
System.Boolean
Overrides

ItemTemplate

Accepts the template design and assigns it to each list item present in the popup. We have built-in template engine

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

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

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

NameSpace

Declaration
protected override string NameSpace { get; }
Property Value
Type Description
System.String
Overrides

NoRecordsTemplate

Accepts the template design and assigns it to popup list of component when no data is available on the component.

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

Open

Triggers when the popup opens.

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

Placeholder

Specifies a short hint that describes the expected value of the DropDownList component.

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

PopupHeight

Specifies the height of the popup list.

For more details about the popup configuration refer to Popup Configuration documentation.

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

PopupWidth

Specifies the width of the popup list. By default, the popup width sets based on the width of the component.

For more details about the popup configuration refer to Popup Configuration documentation.

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

Query

Accepts the external Query that execute along with data processing.

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

Readonly

When set to true, the user interactions on the component are disabled.

Declaration
[HtmlAttributeName("readonly")]
public bool Readonly { get; set; }
Property Value
Type Description
System.Boolean

Select

Triggers when an item in the popup is selected by the user either with mouse/tap or with keyboard navigation.

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

ShowClearButton

Specifies whether to show or hide the clear button. When the clear button is clicked, value, text, and index properties are reset to null.

Declaration
[HtmlAttributeName("showClearButton")]
public bool ShowClearButton { get; set; }
Property Value
Type Description
System.Boolean

SortOrder

Specifies the sortOrder to sort the data source. The available type of sort orders are None - The data source is not sorting. Ascending - The data source is sorting with ascending order. Descending - The data source is sorting with descending order.

Declaration
[HtmlAttributeName("sortOrder")]
public object SortOrder { get; set; }
Property Value
Type Description
System.Object

TagName

Declaration
protected override string TagName { get; }
Property Value
Type Description
System.String
Overrides

Text

Gets or sets the display text of the selected item in the component.

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

Value

Gets or sets the value of the selected item in the component.

Declaration
[HtmlAttributeName("value")]
public object Value { get; set; }
Property Value
Type Description
System.Object

Width

Specifies the width of the component. By default, the component width sets based on the width of its parent container. You can also set the width in pixel values.

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

ZIndex

specifies the z-index value of the component popup element.

Declaration
[HtmlAttributeName("zIndex")]
public double ZIndex { get; set; }
Property Value
Type Description
System.Double