This section describes members used to manipulate the UI component.
Postpones rendering that can negatively affect performance until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See AlsoSpecifies the device-dependent default configuration properties for this component.
Parameters:The component's default device properties.
Object structure:
Name Type Description device |Device parameters.
When you specify a function, get information about the current device from the argument. Return true if the properties should be applied to the device.
Options to be applied.
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.
jQueryDevExpress.ui.dxTabPanel.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the TabPanel properties } });Angular
import TabPanel, { Properties } from "devextreme/ui/tab_panel"; // ... export class AppComponent { constructor () { TabPanel.defaultOptions<Properties>({ 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 dxTabPanel from "devextreme/ui/tab_panel"; import TabPanel from "devextreme-react/tab-panel"; dxTabPanel.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the TabPanel properties } }); export default function App() { return ( <div> <TabPanel id="tabPanel1" /> <TabPanel id="tabPanel2" /> </div> ) }
You can also set rules for multiple device types:
jQueryconst devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { DevExpress.ui.dxTabPanel.defaultOptions({ device: deviceConfig, options: { // Here go the TabPanel properties } }); });Angular
import TabPanel, { Properties } from "devextreme/ui/tab_panel"; // ... export class AppComponent { constructor () { const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { TabPanel.defaultOptions<Properties>({ device: deviceConfig, options: { // Here go the TabPanel properties } }); }); } }Vue
<template> <div> <DxTabPanel /> </div> </template> <script> import DxTabPanel from "devextreme-vue/tab-panel"; import TabPanel from "devextreme/ui/tab_panel"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { TabPanel.defaultOptions({ device: deviceConfig, options: { // Here go the TabPanel properties } }); }); export default { components: { DxTabPanel } } </script>React
import dxTabPanel from "devextreme/ui/tab_panel"; import TabPanel from "devextreme-react/tab-panel"; const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { dxTabPanel.defaultOptions({ device: deviceConfig, options: { // Here go the TabPanel properties } }); }); export default function App() { return ( <div> <TabPanel /> </div> ) }
Disposes of all the resources allocated to the TabPanel instance.
jQueryAfter calling this method, remove the DOM element associated with the UI component:
$("#myTabPanel").dxTabPanel("dispose"); $("#myTabPanel").remove();Angular
Use conditional rendering instead of this method:
<dx-tab-panel ... *ngIf="condition"> </dx-tab-panel>Vue
Use conditional rendering instead of this method:
<template> <DxTabPanel ... v-if="condition"> </DxTabPanel> </template> <script> import DxTabPanel from 'devextreme-vue/tab-panel'; export default { components: { DxTabPanel } } </script>React
Use conditional rendering instead of this method:
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;
Gets the root UI component element.
Refreshes the UI component after a call of the beginUpdate() method.
The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.
See AlsoSets focus on the UI component.
Gets the instance of a UI component found using its DOM node.
Parameters:The UI component's container.
The UI component's instance.
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
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
Detaches all event handlers from a single event.
The object for which this method is called.
Detaches a particular event handler from a single event.
Parameters:The event's name.
The event's handler.
The object for which this method is called.
Subscribes to an event.
Parameters:The event's name.
The event's handler.
The object for which this method is called.
Use this method to subscribe to one of the events listed in the Events section.
See AlsoSubscribes to events.
Parameters: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 AlsoGets the value of a single property.
Parameters:The property's name or full path.
Return Value: any
This property's value.
Updates the value of a single property.
Parameters:The property's name or full path.
optionValue: any
This property's new value.
Updates the values of several properties.
Parameters:Options with their new values.
Registers a handler to be executed when a user presses a specific key.
Parameters:A key.
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:
A custom handler for a key cancels the default handler for this key.
See AlsoRenders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.
Resets a property to its default value.
Feel free to share topic-related thoughts here.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4