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