React DropDownButton Methods
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
close()
A Promise that is resolved when the drop-down menu is closed. It is a native Promise or a jQuery.Promise when you use jQuery.
defaultOptions(rule)
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 DropDownButton UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxDropDownButton.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the DropDownButton options } });
Angular
import DropDownButton from "devextreme/ui/drop_down_button"; // ... export class AppComponent { constructor () { DropDownButton.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the DropDownButton options } }); } }
Vue
<template> <div> <DxDropDownButton id="dropDownButton1" /> <DxDropDownButton id="dropDownButton2" /> </div> </template> <script> import DxDropDownButton from "devextreme-vue/drop-down-button"; import DropDownButton from "devextreme/ui/drop_down_button"; DropDownButton.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the DropDownButton options } }); export default { components: { DxDropDownButton } } </script>
React
import React from "react"; import dxDropDownButton from "devextreme/ui/drop_down_button"; import DropDownButton from "devextreme-react/drop-down-button"; class App extends React.Component { render () { dxDropDownButton.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the DropDownButton options } }) return ( <div> <DropDownButton id="dropDownButton1" /> <DropDownButton id="dropDownButton2" /> </div> ) } } export default App;
dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myDropDownButton").dxDropDownButton("dispose"); $("#myDropDownButton").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-drop-down-button ... *ngIf="condition"> </dx-drop-down-button>
Vue
<template> <DxDropDownButton ... v-if="condition"> </DxDropDownButton> </template> <script> import DxDropDownButton from 'devextreme-vue/drop-down-button'; export default { components: { DxDropDownButton } } </script>
React
import React from 'react'; import DropDownButton from 'devextreme-react/drop-down-button'; function DxDropDownButton(props) { if (!props.shouldRender) { return null; } return ( <DropDownButton ... > </DropDownButton> ); } class App extends React.Component { render() { return ( <DxDropDownButton shouldRender="condition" /> ); } } export default App;
See Also
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
focus()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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 UI component class supports. The following code demonstrates how to get the DropDownButton instance found in an element with the myDropDownButton
ID:
// Modular approach import DropDownButton from "devextreme/ui/drop_down_button"; ... let element = document.getElementById("myDropDownButton"); let instance = DropDownButton.getInstance(element) as DropDownButton; // Non-modular approach let element = document.getElementById("myDropDownButton"); let instance = DevExpress.ui.dxDropDownButton.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()
A Promise that is resolved when the drop-down menu is opened. It is a native Promise or a jQuery.Promise when you use jQuery.
option()
Gets all UI component properties.
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
resetOption(optionName)
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
toggle()
A Promise that is resolved when the drop-down menu is opened or closed. It is a native Promise or a jQuery.Promise when you use jQuery.
toggle(visibility)
A Promise that is resolved when the drop-down menu is opened or closed. It is a native Promise or a jQuery.Promise when you use jQuery.
If you have technical questions, please create a support ticket in the DevExpress Support Center.