JavaScript/jQuery Switch Methods
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
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 Switch UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxSwitch.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Switch properties
}
});Angular
import Switch from "devextreme/ui/switch";
// ...
export class AppComponent {
constructor () {
Switch.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Switch properties
}
});
}
}Vue
<template>
<div>
<DxSwitch id="switch1" />
<DxSwitch id="switch2" />
</div>
</template>
<script>
import DxSwitch from "devextreme-vue/switch";
import Switch from "devextreme/ui/switch";
Switch.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Switch properties
}
});
export default {
components: {
DxSwitch
}
}
</script>React
import React, {useEffect} from "react";
import dxSwitch from "devextreme/ui/switch";
import Switch from "devextreme-react/switch";
export default function App() {
useEffect(() => {
dxSwitch.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Switch properties
}
})
});
return (
<div>
<Switch id="switch1" />
<Switch id="switch2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#mySwitch").dxSwitch("dispose");
$("#mySwitch").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-switch ...
*ngIf="condition">
</dx-switch>Vue
<template>
<DxSwitch ...
v-if="condition">
</DxSwitch>
</template>
<script>
import DxSwitch from 'devextreme-vue/switch';
export default {
components: {
DxSwitch
}
}
</script>React
import React from 'react';
import Switch from 'devextreme-react/switch';
function DxSwitch(props) {
if (!props.shouldRender) {
return null;
}
return (
<Switch ... >
</Switch>
);
}
class App extends React.Component {
render() {
return (
<DxSwitch shouldRender="condition" />
);
}
}
export default App;See Also
getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Switch instance found in an element with the mySwitch ID:
// Modular approach
import Switch from "devextreme/ui/switch";
...
let element = document.getElementById("mySwitch");
let instance = Switch.getInstance(element) as Switch;
// Non-modular approach
let element = document.getElementById("mySwitch");
let instance = DevExpress.ui.dxSwitch.getInstance(element);See Also
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a EventObject 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.