Search results

ComboBoxModel

Interface for a class ComboBox

Properties

actionBegin

EmitType<Object>

Triggers before fetching data from the remote server.

actionComplete

EmitType<Object>

Triggers after data is fetched successfully from the remote server.

actionFailure

EmitType<Object>

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

beforeOpen

EmitType<Object>

Triggers when the popup before opens.

blur

EmitType<Object>

Triggers when focus moves out from the component.

change

EmitType<ChangeEventArgs>

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

close

EmitType<PopupEventArgs>

Triggers when the popup is closed.

created

EmitType<Object>

Triggers when the component is created.

customValueSpecifier

EmitType<CustomValueSpecifierEventArgs>

Triggers on set a custom value to this component.

dataBound

EmitType<Object>

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

destroyed

EmitType<Object>

Triggers when the component is destroyed.

filtering

EmitType<FilteringEventArgs>

Triggers on typing a character in the component.

For more details about the filtering refer to Filtering documentation.

focus

EmitType<Object>

Triggers when the component is focused.

open

EmitType<PopupEventArgs>

Triggers when the popup opens.

select

EmitType<SelectEventArgs>

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

actionFailureTemplate

string

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

allowCustom

boolean

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

allowFiltering

boolean

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. {% codeBlock src=“combobox/allow-filtering-api/index.ts” %}{% endcodeBlock %}

{% codeBlock src=“combobox/allow-filtering-api/index.html” %}{% endcodeBlock %}

autofill

boolean

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

cssClass

string

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

dataSource

Object[] | DataManager | string[] | number[] | boolean[]

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.

enablePersistence

boolean

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

  1. value

enableRtl

boolean

When set to true, enables RTL mode of the component that displays the content in the right-to-left direction.

enabled

boolean

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

fields

FieldSettingsModel

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.

    <input type="text" tabindex="1" id="list"> </input>
    let customers: DropDownList = new DropDownList({
     dataSource:new DataManager({ url:'http://js.syncfusion.com/demos/ejServices/Wcf/Northwind.svc/' }),
     query: new Query().from('Customers').select(['ContactName', 'CustomerID']).take(5),
     fields: { text: 'ContactName', value: 'CustomerID' },
     placeholder: 'Select a customer'
    });
    customers.appendTo("#list");

floatLabelType

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. {% codeBlock src=“combobox/float-label-type-api/index.ts” %}{% endcodeBlock %}

{% codeBlock src=“combobox/float-label-type-api/index.html” %}{% endcodeBlock %}

footerTemplate

string

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.

groupTemplate

string

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

headerTemplate

string

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.

htmlAttributes

Object

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format. {% codeBlock src=“combobox/html-attributes-api/index.ts” %}{% endcodeBlock %}

{% codeBlock src=“combobox/html-attributes-api/index.html” %}{% endcodeBlock %}

ignoreAccent

boolean

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

index

number

Gets or sets the index of the selected item in the component. {% codeBlock src=“combobox/index-api/index.ts” %}{% endcodeBlock %}

{% codeBlock src=“combobox/index-api/index.html” %}{% endcodeBlock %}

itemTemplate

string

Accepts the template design and assigns it to each list item present in the popup. We have built-in template engine which provides options to compile template string into a executable function. For EX: We have expression evolution as like ES6 expression string literals.

locale

string

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

noRecordsTemplate

string

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

placeholder

string

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

popupHeight

string | number

Specifies the height of the popup list.

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

popupWidth

string | number

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.

query

Query

Accepts the external Query that execute along with data processing. {% codeBlock src=“combobox/query-api/index.ts” %}{% endcodeBlock %}

{% codeBlock src=“combobox/query-api/index.html” %}{% endcodeBlock %}

readonly

boolean

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

showClearButton

boolean

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

sortOrder

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.

text

string

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

value

number | string | boolean

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

width

string | number

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.

zIndex

number

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