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
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 Toast widget in an application executed on the desktop.
jQuery
DevExpress.ui.dxToast.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Toast options } });
Angular
import Toast from "devextreme/ui/toast"; // ... export class AppComponent { constructor () { Toast.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Toast options } }); } }
Vue
<template> <div> <dx-toast id="toast1" /> <dx-toast id="toast2" /> </div> </template> <script> import DxToast from "devextreme-vue/toast"; import Toast from "devextreme/ui/toast"; Toast.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Toast options } }); export default { components: { DxToast } } </script>
React
import React from "react"; import dxToast from "devextreme/ui/toast"; import Toast from "devextreme-react/toast"; class App extends React.Component { render () { dxToast.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Toast options } }) return ( <div> <Toast id="toast1" /> <Toast id="toast2" /> </div> ) } } export default App;
dispose()
The following code disposes of an Toast instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:
jQuery
$("#myToast").dxToast("dispose"); $("#myToast").remove();
Angular
<dx-toast #toastVar id="myToast"></dx-toast>
import { ..., ViewChild } from "@angular/core"; import { DxToastComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("toastVar") toast: DxToastComponent; removeToast (e) { this.toast.instance.dispose(); document.getElementById("myToast").remove(); } }
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
getInstance(element)
getInstance is a static method that the widget class supports. The following code demonstrates how to get the Toast instance found in an element with the myToast
ID:
// Modular approach import Toast from "devextreme/ui/toast"; ... let element = document.getElementById("myToast"); let instance = Toast.getInstance(element) as Toast; // Non-modular approach let element = document.getElementById("myToast"); let instance = DevExpress.ui.dxToast.getInstance(element);
See Also
hide()
A Promise that is resolved after the widget is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
option()
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(optionName)
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(optionName, optionValue)
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(options)
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
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
show()
A Promise that is resolved after the widget is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
toggle(showing)
A Promise that is resolved after the widget is shown/hidden. It is a native Promise or a jQuery.Promise when you use jQuery.