JavaScript/jQuery Toast Methods
This section describes members used to manipulate the widget.
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
content()
Gets the widget's content.
An HTML element or a jQuery element when you use jQuery.
defaultOptions(rule)
Specifies the device-dependent default configuration options for this component.
The component's default device options.
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 } }); } }
dispose()
Disposes of all the resources allocated to the Toast instance.
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(); } }
element()
Gets the root widget element.
An HTML element or a jQuery element when you use jQuery.
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
getInstance(element)
Gets the instance of a widget found using its DOM node.
The widget's instance.
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()
Hides the widget.
A Promise that is resolved after the widget is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
instance()
Gets the widget's instance. Use it to access other methods of the widget.
This widget's instance.
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
option()
Gets all widget options.
The widget's options.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(optionName)
Gets the value of a single option.
The option's name or full path.
This option's value.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(optionName, optionValue)
Updates the value of a single option.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
option(options)
Updates the values of several options.
Options with their new values.
See Also
- Get and Set Options
- Call Methods: jQuery | Angular | AngularJS | Knockout | Vue | React | ASP.NET MVC
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
show()
Shows the widget.
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)
Shows or hides the widget depending on the argument.
Specifies whether to show or hide the widget.
A Promise that is resolved after the widget is shown/hidden. 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.