JavaScript/jQuery TabPanel 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 TabPanel UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxTabPanel.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the TabPanel properties
}
});Angular
import TabPanel from "devextreme/ui/tab_panel";
// ...
export class AppComponent {
constructor () {
TabPanel.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the TabPanel properties
}
});
}
}Vue
<template>
<div>
<DxTabPanel id="tabPanel1" />
<DxTabPanel id="tabPanel2" />
</div>
</template>
<script>
import DxTabPanel from "devextreme-vue/tab-panel";
import TabPanel from "devextreme/ui/tab_panel";
TabPanel.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the TabPanel properties
}
});
export default {
components: {
DxTabPanel
}
}
</script>React
import React, {useEffect} from "react";
import dxTabPanel from "devextreme/ui/tab_panel";
import TabPanel from "devextreme-react/tab-panel";
export default function App() {
useEffect(() => {
dxTabPanel.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the TabPanel properties
}
})
});
return (
<div>
<TabPanel id="tabPanel1" />
<TabPanel id="tabPanel2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myTabPanel").dxTabPanel("dispose");
$("#myTabPanel").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-tab-panel ...
*ngIf="condition">
</dx-tab-panel>Vue
<template>
<DxTabPanel ...
v-if="condition">
</DxTabPanel>
</template>
<script>
import DxTabPanel from 'devextreme-vue/tab-panel';
export default {
components: {
DxTabPanel
}
}
</script>React
import React from 'react';
import TabPanel from 'devextreme-react/tab-panel';
function DxTabPanel(props) {
if (!props.shouldRender) {
return null;
}
return (
<TabPanel ... >
</TabPanel>
);
}
class App extends React.Component {
render() {
return (
<DxTabPanel shouldRender="condition" />
);
}
}
export default App;See Also
getDataSource()
Gets the DataSource instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout
- Data Layer - Overview
- Data Layer - DataSource Examples
getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the TabPanel instance found in an element with the myTabPanel ID:
// Modular approach
import TabPanel from "devextreme/ui/tab_panel";
...
let element = document.getElementById("myTabPanel");
let instance = TabPanel.getInstance(element) as TabPanel;
// Non-modular approach
let element = document.getElementById("myTabPanel");
let instance = DevExpress.ui.dxTabPanel.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.