beginUpdate()
Prevents the widget from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget 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()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
close()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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)
defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the SelectBox widget 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()
After calling this method, remove the DOM element associated with the widget:
jQuery
$("#mySelectBox").dxSelectBox("dispose"); $("#mySelectBox").remove();
Angular
<dx-select-box #selectBoxVar id="mySelectBox"></dx-select-box>
import { ..., ViewChild } from "@angular/core"; import { DxSelectBoxComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("selectBoxVar", { static: false }) selectBox: DxSelectBoxComponent; // Prior to Angular 8 // @ViewChild("selectBoxVar") selectBox: DxSelectBoxComponent; removeSelectBox (e) { this.selectBox.instance.dispose(); document.getElementById("mySelectBox").remove(); } }
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 widget 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()
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()
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 widget's methods, for example, focus():
jQuery
var 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.
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)
getInstance is a static method that the widget 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()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
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)
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()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all widget options.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
registerKeyHandler(key, handler)
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()
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 option to the default value.
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.