Angular SelectBox API
The SelectBox widget is an editor that allows an end user to select an item from a drop-down list.
See Also
- Set Up DevExtreme: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Properties
An object defining configuration options for the SelectBox widget.
| Name | Description |
|---|---|
| acceptCustomValue | Specifies whether the widget allows a user to enter a custom value. Requires the onCustomItemCreating handler implementation. |
| accessKey | Specifies the shortcut key that sets focus on the widget. |
| activeStateEnabled | Specifies whether or not the widget changes its state when interacting with a user. |
| buttons | Allows you to add custom buttons to the input text field. |
| dataSource | Binds the widget to data. |
| deferRendering | Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately. |
| disabled | Specifies whether the widget responds to user interaction. |
| displayExpr | Specifies the data field whose values should be displayed. |
| displayValue | Returns the value currently displayed by the widget. |
| dropDownButtonComponent | An alias for the dropDownButtonTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information. |
| dropDownButtonRender | An alias for the dropDownButtonTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information. |
| dropDownButtonTemplate | Specifies a custom template for the drop-down button. |
| elementAttr | Specifies the attributes to be attached to the widget's root element. |
| fieldComponent | An alias for the fieldTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information. |
| fieldRender | An alias for the fieldTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information. |
| fieldTemplate | Specifies a custom template for the text field. Must contain the TextBox widget. |
| focusStateEnabled | Specifies whether the widget can be focused using keyboard navigation. |
| groupComponent | An alias for the groupTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information. |
| grouped | Specifies whether data items should be grouped. |
| groupRender | An alias for the groupTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information. |
| groupTemplate | Specifies a custom template for group captions. |
| height | Specifies the widget's height. |
| hint | Specifies text for a hint that appears when a user pauses on the widget. |
| hoverStateEnabled | Specifies whether the widget changes its state when a user pauses on it. |
| inputAttr | Specifies the attributes to be passed on to the underlying HTML element. |
| isValid | Specifies or indicates whether the editor's value is valid. |
| itemComponent | An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information. |
| itemRender | An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information. |
| items | An array of items displayed by the widget. |
| itemTemplate | Specifies a custom template for items. |
| maxLength | Specifies the maximum number of characters you can enter into the textbox. |
| minSearchLength | The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true. |
| name | The value to be assigned to the |
| noDataText | The text or HTML markup displayed by the widget if the item collection is empty. |
| onChange | A function that is executed when the widget loses focus after the text field's content was changed using the keyboard. |
| onClosed | A function that is executed once the drop-down editor is closed. |
| onContentReady | A function that is executed when the widget's content is ready and each time the content is changed. |
| onCopy | A function that is executed when the widget's input has been copied. |
| onCustomItemCreating | A function that is executed when a user adds a custom item. Requires acceptCustomValue to be set to true. |
| onCut | A function that is executed when the widget's input has been cut. |
| onDisposing | A function that is executed before the widget is disposed of. |
| onEnterKey | A function that is executed when the Enter key has been pressed while the widget is focused. |
| onFocusIn | A function that is executed when the widget gets focus. |
| onFocusOut | A function that is executed when the widget loses focus. |
| onInitialized | A function used in JavaScript frameworks to save the widget instance. |
| onInput | A function that is executed each time the widget's input is changed while the widget is focused. |
| onItemClick | A function that is executed when a list item is clicked or tapped. |
| onKeyDown | A function that is executed when a user is pressing a key on the keyboard. |
| onKeyPress | A function that is executed when a user presses a key on the keyboard. |
| onKeyUp | A function that is executed when a user releases a key on the keyboard. |
| onOpened | A function that is executed once the drop-down editor is opened. |
| onOptionChanged | A function that is executed after a widget option is changed. |
| onPaste | A function that is executed when the widget's input has been pasted. |
| onSelectionChanged | A function that is executed when a list item is selected or selection is canceled. |
| onValueChanged | A function that is executed after the widget's value is changed. |
| opened | Specifies whether or not the drop-down editor is displayed. |
| openOnFieldClick | Specifies whether a user can open the drop-down list by clicking a text field. |
| placeholder | The text that is provided as a hint in the select box editor. |
| readOnly | Specifies whether the editor is read-only. |
| rtlEnabled | Switches the widget to a right-to-left representation. |
| searchEnabled | Specifies whether to allow searching. |
| searchExpr | Specifies the name of a data source item field or an expression whose value is compared to the search criterion. |
| searchMode | Specifies a comparison operation used to search widget items. |
| searchTimeout | Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed. |
| selectedItem | Gets the currently selected item. |
| showClearButton | Specifies whether to display the Clear button in the widget. |
| showDataBeforeSearch | Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value. |
| showDropDownButton | Specifies whether the drop-down button is visible. |
| showSelectionControls | Specifies whether or not to display selection controls. |
| spellcheck | Specifies whether or not the widget checks the inner text for spelling mistakes. |
| stylingMode | Specifies how the widget's text field is styled. |
| tabIndex | Specifies the number of the element when the Tab key is used for navigating. |
| text | The read-only option that holds the text displayed by the widget input element. |
| validationError | Information on the broken validation rule. Contains the first item from the validationErrors array. |
| validationErrors | An array of the validation rules that failed. |
| validationMessageMode | Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed. |
| validationStatus | Indicates or specifies the current validation status. |
| value | Specifies the currently selected value. May be an object if dataSource contains objects and valueExpr is not set. |
| valueChangeEvent | Specifies the DOM events after which the widget's value should be updated. Applies only if acceptCustomValue is set to true. |
| valueExpr | Specifies which data field provides unique values to the widget's value. |
| visible | Specifies whether the widget is visible. |
| width | Specifies the widget's width. |
| wrapItemText | Specifies whether text that exceeds the drop-down list width should be wrapped. |
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Methods
This section describes members used to manipulate data.
| Name | Description |
|---|---|
| beginUpdate() | Prevents the widget from refreshing until the endUpdate() method is called. |
| blur() | Removes focus from the input element. |
| close() | Closes the drop-down editor. |
| content() | Gets the popup window's content. |
| defaultOptions(rule) | Specifies the device-dependent default configuration options for this component. |
| dispose() | Disposes of all the resources allocated to the SelectBox instance. |
| element() | Gets the root widget element. |
| endUpdate() | Refreshes the widget after a call of the beginUpdate() method. |
| field() | Gets the widget's |
| focus() | Sets focus to the input element representing the widget. |
| getButton(name) | Gets an instance of a custom action button. |
| getDataSource() | Gets the DataSource instance. |
| getInstance(element) | Gets the instance of a widget found using its DOM node. |
| instance() | Gets the widget's instance. Use it to access other methods of the widget. |
| off(eventName) | Detaches all event handlers from a single event. |
| off(eventName, eventHandler) | Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) | Subscribes to an event. |
| on(events) | Subscribes to events. |
| open() | Opens the drop-down editor. |
| option() | Gets all widget options. |
| option(optionName) | Gets the value of a single option. |
| option(optionName, optionValue) | Updates the value of a single option. |
| option(options) | Updates the values of several options. |
| registerKeyHandler(key, handler) | Registers a handler to be executed when a user presses a specific key. |
| repaint() | Repaints the widget without reloading data. Call it to update the widget's markup. |
| reset() | Resets the value option to the default value. |
| resetOption(optionName) | Resets an option to its default value. |
Events
This section describes events fired by this widget.
| Name | Description |
|---|---|
| change | Raised when the widget loses focus after the text field's content was changed using the keyboard. |
| closed | Raised once the drop-down editor is closed. |
| contentReady | Raised when the widget's content is ready. |
| copy | Raised when the widget's input has been copied. |
| customItemCreating | Raised when a user adds a custom item. |
| cut | Raised when the widget's input has been cut. |
| disposing | Raised before the widget is disposed of. |
| enterKey | Raised when the Enter key has been pressed while the widget is focused. |
| focusIn | Raised when the widget gets focus. |
| focusOut | Raised when the widget loses focus. |
| initialized | Raised only once, after the widget is initialized. |
| input | Raised each time the widget's input is changed while the widget is focused. |
| itemClick | Raised when a list item is clicked or tapped. |
| keyDown | Raised when a user is pressing a key on the keyboard. |
| keyPress | Raised when a user presses a key on the keyboard. |
| keyUp | Raised when a user releases a key on the keyboard. |
| opened | Raised once the drop-down editor is opened. |
| optionChanged | Raised after a widget option is changed. |
| paste | Raised when the widget's input has been pasted. |
| selectionChanged | Raised when a list item is selected or selection is canceled. |
| valueChanged | Raised after the widget's value is changed. |
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
If you have technical questions, please create a support ticket in the DevExpress Support Center.