JavaScript/jQuery CheckBox 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 CheckBox UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxCheckBox.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the CheckBox properties
}
});Angular
import CheckBox from "devextreme/ui/check_box";
// ...
export class AppComponent {
constructor () {
CheckBox.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the CheckBox properties
}
});
}
}Vue
<template>
<div>
<DxCheckBox id="checkBox1" />
<DxCheckBox id="checkBox2" />
</div>
</template>
<script>
import DxCheckBox from "devextreme-vue/check-box";
import CheckBox from "devextreme/ui/check_box";
CheckBox.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the CheckBox properties
}
});
export default {
components: {
DxCheckBox
}
}
</script>React
import React, {useEffect} from "react";
import dxCheckBox from "devextreme/ui/check_box";
import CheckBox from "devextreme-react/check-box";
export default function App() {
useEffect(() => {
dxCheckBox.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the CheckBox properties
}
})
});
return (
<div>
<CheckBox id="checkBox1" />
<CheckBox id="checkBox2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myCheckBox").dxCheckBox("dispose");
$("#myCheckBox").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-check-box ...
*ngIf="condition">
</dx-check-box>Vue
<template>
<DxCheckBox ...
v-if="condition">
</DxCheckBox>
</template>
<script>
import DxCheckBox from 'devextreme-vue/check-box';
export default {
components: {
DxCheckBox
}
}
</script>React
import React from 'react';
import CheckBox from 'devextreme-react/check-box';
function DxCheckBox(props) {
if (!props.shouldRender) {
return null;
}
return (
<CheckBox ... >
</CheckBox>
);
}
class App extends React.Component {
render() {
return (
<DxCheckBox 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 CheckBox instance found in an element with the myCheckBox ID:
// Modular approach
import CheckBox from "devextreme/ui/check_box";
...
let element = document.getElementById("myCheckBox");
let instance = CheckBox.getInstance(element) as CheckBox;
// Non-modular approach
let element = document.getElementById("myCheckBox");
let instance = DevExpress.ui.dxCheckBox.getInstance(element);See Also
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.