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 ColorBox UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxColorBox.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the ColorBox properties
}
});Angular
import ColorBox, { Properties } from "devextreme/ui/color_box";
// ...
export class AppComponent {
constructor () {
ColorBox.defaultOptions<Properties>({
device: { deviceType: "desktop" },
options: {
// Here go the ColorBox properties
}
});
}
}Vue
<template>
<div>
<DxColorBox id="colorBox1" />
<DxColorBox id="colorBox2" />
</div>
</template>
<script>
import DxColorBox from "devextreme-vue/color-box";
import ColorBox from "devextreme/ui/color_box";
ColorBox.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the ColorBox properties
}
});
export default {
components: {
DxColorBox
}
}
</script>React
import dxColorBox from "devextreme/ui/color_box";
import ColorBox from "devextreme-react/color-box";
dxColorBox.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the ColorBox properties
}
});
export default function App() {
return (
<div>
<ColorBox id="colorBox1" />
<ColorBox id="colorBox2" />
</div>
)
}dispose()
jQuery
After calling this method, remove the DOM element associated with the UI component:
$("#myColorBox").dxColorBox("dispose");
$("#myColorBox").remove();Angular
Use conditional rendering instead of this method:
<dx-color-box ...
*ngIf="condition">
</dx-color-box>Vue
Use conditional rendering instead of this method:
<template>
<DxColorBox ...
v-if="condition">
</DxColorBox>
</template>
<script>
import DxColorBox from 'devextreme-vue/color-box';
export default {
components: {
DxColorBox
}
}
</script>React
Use conditional rendering instead of this method:
import React from 'react';
import ColorBox from 'devextreme-react/color-box';
function DxColorBox(props) {
if (!props.shouldRender) {
return null;
}
return (
<ColorBox ... >
</ColorBox>
);
}
class App extends React.Component {
render() {
return (
<DxColorBox shouldRender="condition" />
);
}
}
export default App;endUpdate()
Refreshes the UI component after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
getButton(name)
Gets an instance of a custom action button.
Use the returned button instance to call the Button UI component's methods, for example, focus():
jQuery
const myCustomButton = $("#colorBoxContainer").dxColorBox("getButton", "myCustomButton");
myCustomButton.focus();Angular
import { Component, ViewChild } from '@angular/core';
import { DxColorBoxComponent } from 'devextreme-angular';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent {
@ViewChild('colorBoxRef', { static: false }) colorBox: DxColorBoxComponent;
// Prior to Angular 8
// @ViewChild('colorBoxRef') colorBox: DxColorBoxComponent;
setFocus() {
this.colorBox.instance.getButton('myCustomButton').focus();
}
}<dx-color-box #colorBoxRef ... > </dx-color-box>
Vue
<template>
<DxColorBox ...
:ref="colorBoxRef">
</DxColorBox>
</template>
<script>
import 'devextreme/dist/css/dx.light.css';
import DxColorBox from 'devextreme-vue/color-box';
export default {
components: {
DxColorBox
},
data() {
return {
colorBoxRef
}
},
methods: {
setFocus() {
this.colorBox.getButton('myCustomButton').focus();
}
},
computed: {
colorBox: function() {
return this.$refs[colorBoxRef].instance;
}
}
}
</script>React
import React from 'react';
import 'devextreme/dist/css/dx.light.css';
import ColorBox from 'devextreme-react/color-box';
class App extends React.Component {
constructor(props) {
super(props);
this.colorBoxRef = React.createRef();
this.setFocus = () => {
this.colorBox.getButton('myCustomButton').focus();
};
}
get colorBox() {
return this.colorBoxRef.current.instance;
}
render() {
return (
<ColorBox ...
ref={this.colorBoxRef}>
</ColorBox>
);
}
}
export default App;getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the ColorBox instance found in an element with the myColorBox ID:
// Modular approach
import ColorBox from "devextreme/ui/color_box";
...
let element = document.getElementById("myColorBox");
let instance = ColorBox.getInstance(element) as ColorBox;
// Non-modular approach
let element = document.getElementById("myColorBox");
let instance = DevExpress.ui.dxColorBox.getInstance(element);See Also
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
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.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.