JavaScript/jQuery ActionSheet Methods
This section describes the members used to manipulate the UI component.
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
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 ActionSheet UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxActionSheet.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ActionSheet options } });
Angular
import ActionSheet from "devextreme/ui/action_sheet"; // ... export class AppComponent { constructor () { ActionSheet.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ActionSheet options } }); } }
Vue
<template> <div> <DxActionSheet id="actionSheet1" /> <DxActionSheet id="actionSheet2" /> </div> </template> <script> import DxActionSheet from "devextreme-vue/action-sheet"; import ActionSheet from "devextreme/ui/action_sheet"; ActionSheet.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ActionSheet options } }); export default { components: { DxActionSheet } } </script>
React
import React from "react"; import dxActionSheet from "devextreme/ui/action_sheet"; import ActionSheet from "devextreme-react/action-sheet"; class App extends React.Component { render () { dxActionSheet.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the ActionSheet options } }) return ( <div> <ActionSheet id="actionSheet1" /> <ActionSheet id="actionSheet2" /> </div> ) } } export default App;
dispose()
Disposes of all the resources allocated to the ActionSheet instance.
After calling this method, remove the DOM element associated with the UI component:
$("#myActionSheet").dxActionSheet("dispose"); $("#myActionSheet").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-action-sheet ... *ngIf="condition"> </dx-action-sheet>
Vue
<template> <DxActionSheet ... v-if="condition"> </DxActionSheet> </template> <script> import DxActionSheet from 'devextreme-vue/action-sheet'; export default { components: { DxActionSheet } } </script>
React
import React from 'react'; import ActionSheet from 'devextreme-react/action-sheet'; function DxActionSheet(props) { if (!props.shouldRender) { return null; } return ( <ActionSheet ... > </ActionSheet> ); } class App extends React.Component { render() { return ( <DxActionSheet 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
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 ActionSheet instance found in an element with the myActionSheet
ID:
// Modular approach import ActionSheet from "devextreme/ui/action_sheet"; ... let element = document.getElementById("myActionSheet"); let instance = ActionSheet.getInstance(element) as ActionSheet; // Non-modular approach let element = document.getElementById("myActionSheet"); let instance = DevExpress.ui.dxActionSheet.getInstance(element);
See Also
hide()
Hides the UI component.
A Promise that is resolved after the UI component is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
As an alternative, use the toggle(false) method.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
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
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
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
show()
Shows the UI component.
A Promise that is resolved after the UI component is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
As an alternative, use the toggle(true) method.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
toggle(showing)
Shows or hides the UI component depending on the argument.
Specifies whether to show or hide the UI component.
A Promise that is resolved after the UI component is shown/hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
As an alternative, use the show and hide methods.
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.