React SelectBox Methods
This section describes members used to manipulate data.
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
blur()
Removes focus from the input element.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
close()
Closes the drop-down editor.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
content()
Gets the popup window's content.
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
defaultOptions(rule)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the SelectBox UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxSelectBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the SelectBox options } });
Angular
import SelectBox from "devextreme/ui/select_box"; // ... export class AppComponent { constructor () { SelectBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the SelectBox options } }); } }
Vue
<template> <div> <DxSelectBox id="selectBox1" /> <DxSelectBox id="selectBox2" /> </div> </template> <script> import DxSelectBox from "devextreme-vue/select-box"; import SelectBox from "devextreme/ui/select_box"; SelectBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the SelectBox options } }); export default { components: { DxSelectBox } } </script>
React
import React from "react"; import dxSelectBox from "devextreme/ui/select_box"; import SelectBox from "devextreme-react/select-box"; class App extends React.Component { render () { dxSelectBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the SelectBox options } }) return ( <div> <SelectBox id="selectBox1" /> <SelectBox id="selectBox2" /> </div> ) } } export default App;
dispose()
Disposes of all the resources allocated to the SelectBox instance.
After calling this method, remove the DOM element associated with the UI component:
$("#mySelectBox").dxSelectBox("dispose"); $("#mySelectBox").remove();
Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-select-box ... *ngIf="condition"> </dx-select-box>
Vue
<template> <DxSelectBox ... v-if="condition"> </DxSelectBox> </template> <script> import DxSelectBox from 'devextreme-vue/select-box'; export default { components: { DxSelectBox } } </script>
React
import React from 'react'; import SelectBox from 'devextreme-react/select-box'; function DxSelectBox(props) { if (!props.shouldRender) { return null; } return ( <SelectBox ... > </SelectBox> ); } class App extends React.Component { render() { return ( <DxSelectBox shouldRender="condition" /> ); } } export default App;
See Also
element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
field()
Gets the UI component's <input>
element.
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
focus()
Sets focus to the input element representing the UI component.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
getButton(name)
Gets an instance of a custom action button.
Use the returned button instance to call the Button UI component's methods, for example, focus():
jQuery
const myCustomButton = $("#selectBoxContainer").dxSelectBox("getButton", "myCustomButton"); myCustomButton.focus();
Angular
import { Component, ViewChild } from '@angular/core'; import { DxSelectBoxComponent } from 'devextreme-angular'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { @ViewChild('selectBoxRef', { static: false }) selectBox: DxSelectBoxComponent; // Prior to Angular 8 // @ViewChild('selectBoxRef') selectBox: DxSelectBoxComponent; setFocus() { this.selectBox.instance.getButton('myCustomButton').focus(); } }
<dx-select-box #selectBoxRef ... > </dx-select-box>
Vue
<template> <DxSelectBox ... :ref="selectBoxRef"> </DxSelectBox> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxSelectBox from 'devextreme-vue/select-box'; export default { components: { DxSelectBox }, data() { return { selectBoxRef } }, methods: { setFocus() { this.selectBox.getButton('myCustomButton').focus(); } }, computed: { selectBox: function() { return this.$refs[selectBoxRef].instance; } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import SelectBox from 'devextreme-react/select-box'; class App extends React.Component { constructor(props) { super(props); this.selectBoxRef = React.createRef(); this.setFocus = () => { this.selectBox.getButton('myCustomButton').focus(); }; } get selectBox() { return this.selectBoxRef.current.instance; } render() { return ( <SelectBox ... ref={this.selectBoxRef}> </SelectBox> ); } } export default App;
getDataSource()
Gets the DataSource instance.
The DataSource instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Data Layer - Overview
- Data Layer - DataSource Examples
getInstance(element)
Gets the instance of a UI component found using its DOM node.
The UI component's instance.
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the SelectBox instance found in an element with the mySelectBox
ID:
// Modular approach import SelectBox from "devextreme/ui/select_box"; ... let element = document.getElementById("mySelectBox"); let instance = SelectBox.getInstance(element) as SelectBox; // Non-modular approach let element = document.getElementById("mySelectBox"); let instance = DevExpress.ui.dxSelectBox.getInstance(element);
See Also
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
Use this method to subscribe to one of the events listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
open()
Opens the drop-down editor.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all UI component properties.
The UI component's properties.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
Updates the value of a single property.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
Updates the values of several properties.
Propertieswith their new values.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
registerKeyHandler(key, handler)
Registers a handler to be executed when a user presses a specific key.
A key.
A handler. Accepts the keydown event as the argument. It is a dxEvent or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
repaint()
Repaints the UI component without reloading data. Call it to update the UI component's markup.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
reset()
Resets the value property to the default value.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetOption(optionName)
Resets an property to its default value.
An property's name.
See Also
- Call Methods: 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.