jQuery TextBox Methods - DevExtreme jQuery Documentation v23.2 (2024)

beginUpdate()

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 Also
jQuery
  • Call Methods
Angular
  • Call Methods
Vue
  • Call Methods
React
  • Call Methods

blur()

Removes focus from the input element.

See Also
jQuery
  • Call Methods
Angular
  • Call Methods
Vue
  • Call Methods
React
  • Call Methods
  • focus

clear()

Resets the value property to the default value.

See Also
  • reset()
  • reset(value)

defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.

Parameters:

rule:

Object

The component's default device properties.

Object structure:

Name Type Description
device

Device

|

Function

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

Object

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 TextBox UI component in an application executed on the desktop.

jQuery

JavaScript

DevExpress.ui.dxTextBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the TextBox properties }});
Angular

TypeScript

import TextBox, { Properties } from "devextreme/ui/text_box";// ...export class AppComponent { constructor () { TextBox.defaultOptions<Properties>({ device: { deviceType: "desktop" }, options: { // Here go the TextBox properties } }); }}
Vue
<template> <div> <DxTextBox id="textBox1" /> <DxTextBox id="textBox2" /> </div></template><script>import DxTextBox from "devextreme-vue/text-box";import TextBox from "devextreme/ui/text_box";TextBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the TextBox properties }});export default { components: { DxTextBox }}</script>
React
import dxTextBox from "devextreme/ui/text_box";import TextBox from "devextreme-react/text-box";dxTextBox.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the TextBox properties }});export default function App() { return ( <div> <TextBox id="textBox1" /> <TextBox id="textBox2" /> </div> )}

You can also set rules for multiple device types:

jQuery

JavaScript

const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' },];devicesConfig.forEach(deviceConfig => { DevExpress.ui.dxTextBox.defaultOptions({ device: deviceConfig, options: { // Here go the TextBox properties } });});
Angular

TypeScript

import TextBox, { Properties } from "devextreme/ui/text_box";// ...export class AppComponent { constructor () { const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' }, ]; devicesConfig.forEach(deviceConfig => { TextBox.defaultOptions<Properties>({ device: deviceConfig, options: { // Here go the TextBox properties } }); }); }}
Vue
<template> <div> <DxTextBox /> </div></template><script>import DxTextBox from "devextreme-vue/text-box";import TextBox from "devextreme/ui/text_box";const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' },];devicesConfig.forEach(deviceConfig => { TextBox.defaultOptions({ device: deviceConfig, options: { // Here go the TextBox properties } });});export default { components: { DxTextBox }}</script>
React
import dxTextBox from "devextreme/ui/text_box";import TextBox from "devextreme-react/text-box";const devicesConfig = [ { deviceType: 'desktop' }, { deviceType: 'tablet' }, { deviceType: 'phone' },];devicesConfig.forEach(deviceConfig => { dxTextBox.defaultOptions({ device: deviceConfig, options: { // Here go the TextBox properties } });});export default function App() { return ( <div> <TextBox /> </div> )}

dispose()

Disposes of all the resources allocated to the TextBox instance.

jQuery

After calling this method, remove the DOM element associated with the UI component:

JavaScript

$("#myTextBox").dxTextBox("dispose");$("#myTextBox").remove();
Angular

Use conditional rendering instead of this method:

app.component.html

<dx-text-box ... *ngIf="condition"></dx-text-box>
Vue

Use conditional rendering instead of this method:

App.vue

<template> <DxTextBox ... v-if="condition"> </DxTextBox></template><script>import DxTextBox from 'devextreme-vue/text-box';export default { components: { DxTextBox }}</script>
React

Use conditional rendering instead of this method:

App.js

import React from 'react';import TextBox from 'devextreme-react/text-box';function DxTextBox(props) { if (!props.shouldRender) { return null; } return ( <TextBox ... > </TextBox> );}class App extends React.Component { render() { return ( <DxTextBox shouldRender="condition" /> ); }}export default App;

element()

Gets the root UI component element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

See Also
jQuery
  • Call Methods
Angular
  • Call Methods
Vue
  • Call Methods
React
  • Call Methods

endUpdate()

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 Also
jQuery
  • Call Methods
Angular
  • Call Methods
Vue
  • Call Methods
React
  • Call Methods

focus()

Sets focus to the input element representing the UI component.

See Also
jQuery
  • Call Methods
Angular
  • Call Methods
Vue
  • Call Methods
React
  • Call Methods

getButton(name)

Parameters:

name:

String

The button's name.

Return Value:

Button

| undefined

The Button UI component's instance.

Use the returned button instance to call the Button UI component's methods, for example, focus():

jQuery

index.js

const myCustomButton = $("#textBoxContainer").dxTextBox("getButton", "myCustomButton");myCustomButton.focus();
Angular

app.component.ts

app.component.html

import { Component, ViewChild } from '@angular/core';import { DxTextBoxComponent } from 'devextreme-angular';@Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css']})export class AppComponent { @ViewChild('textBoxRef', { static: false }) textBox: DxTextBoxComponent; // Prior to Angular 8 // @ViewChild('textBoxRef') textBox: DxTextBoxComponent; setFocus() { this.textBox.instance.getButton('myCustomButton').focus(); }}
<dx-text-box #textBoxRef ... ></dx-text-box>
Vue

App.vue

<template> <DxTextBox ... :ref="textBoxRef"> </DxTextBox></template><script>import 'devextreme/dist/css/dx.light.css';import DxTextBox from 'devextreme-vue/text-box';export default { components: { DxTextBox }, data() { return { textBoxRef } }, methods: { setFocus() { this.textBox.getButton('myCustomButton').focus(); } }, computed: { textBox: function() { return this.$refs[textBoxRef].instance; } }}</script>
React

App.js

import React from 'react';import 'devextreme/dist/css/dx.light.css';import TextBox from 'devextreme-react/text-box';class App extends React.Component { constructor(props) { super(props); this.textBoxRef = React.createRef(); this.setFocus = () => { this.textBox.getButton('myCustomButton').focus(); }; } get textBox() { return this.textBoxRef.current.instance; } render() { return ( <TextBox ... ref={this.textBoxRef}> </TextBox> ); }}export default App;

getInstance(element)

Gets the instance of a UI component found using its DOM node.

Parameters:

element:

Element

|

jQuery

The UI component's container.

Return Value:

Object

The UI component's instance.

getInstance is a static method that the UI component class supports. The following code demonstrates how to get the TextBox instance found in an element with the myTextBox ID:

// Modular approachimport TextBox from "devextreme/ui/text_box";...let element = document.getElementById("myTextBox");let instance = TextBox.getInstance(element) as TextBox;// Non-modular approachlet element = document.getElementById("myTextBox");let instance = DevExpress.ui.dxTextBox.getInstance(element);
See Also
  • 3rd-Party Frameworks Integration API

instance()

Gets the UI component's instance. Use it to access other methods of the UI component.

Return Value:

TextBox

This UI component's instance.

See Also
jQuery
  • Call Methods
Angular
  • Call Methods
Vue
  • Call Methods
React
  • Call Methods

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

String

The event's name.

Return Value:

TextBox

The object for which this method is called.

See Also
jQuery
  • Handle Events
Angular
  • Event Handling
Vue
  • Event Handling
React
  • Event Handling

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

TextBox

The object for which this method is called.

See Also
jQuery
  • Handle Events
Angular
  • Event Handling
Vue
  • Event Handling
React
  • Event Handling

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

TextBox

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also
jQuery
  • Handle Events
Angular
  • Event Handling
Vue
  • Event Handling
React
  • Event Handling

on(events)

Subscribes to events.

Parameters:

events:

Object

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

TextBox

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 Also
jQuery
  • Handle Events
Angular
  • Event Handling
Vue
  • Event Handling
React
  • Event Handling

option()

Gets all UI component properties.

Return Value:

Object

The UI component's properties.

See Also
  • Get and Set Properties
jQuery
  • Call Methods
Angular
  • Call Methods
Vue
  • Call Methods
React
  • Call Methods

option(optionName)

Gets the value of a single property.

Parameters:

optionName:

String

The property's name or full path.

Return Value: any

This property's value.

See Also
  • Get and Set Properties
jQuery
  • Call Methods
Angular
  • Call Methods
Vue
  • Call Methods
React
  • Call Methods

option(optionName, optionValue)

Updates the value of a single property.

Parameters:

optionName:

String

The property's name or full path.

optionValue: any

This property's new value.

See Also
  • Get and Set Properties
jQuery
  • Call Methods
Angular
  • Call Methods
Vue
  • Call Methods
React
  • Call Methods

option(options)

Updates the values of several properties.

Parameters:

options:

Object

Options with their new values.

See Also
  • Get and Set Properties
jQuery
  • Call Methods
Angular
  • Call Methods
Vue
  • Call Methods
React
  • Call Methods

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

Parameters:

key:

String

A key.

handler:

Function

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
jQuery
  • Call Methods
Angular
  • Call Methods
Vue
  • Call Methods
React
  • Call Methods

repaint()

Renders the component again without reloading data. Use the method to update the component's markup and appearance dynamically.

The repaint() method re-initializes the component with new settings, resetting its state and history.

View on GitHub

See Also
  • reload() in DataSource | List
  • refresh() in DataGrid | TreeList
jQuery
  • Call Methods
Angular
  • Call Methods
Vue
  • Call Methods
React
  • Call Methods

reset()

Resets the value property to the initial value.

This method sets the isDirty flag to false.

See Also
  • clear()
  • reset(value)

reset(value)

Resets the value property to the value passed as an argument.

Parameters:

value:

String

Specifies the new value.

This method sets the isDirty flag to false.

See Also
  • reset()
  • clear()

resetOption(optionName)

Resets a property to its default value.

Parameters:

optionName:

String

A property's name.

See Also
jQuery
  • Call Methods
Angular
  • Call Methods
Vue
  • Call Methods
React
  • Call Methods

Was this topic helpful?

Feel free toshare topic-related thoughts here.
Ifyou have technical questions, please create asupport ticket inthe DevExpress Support Center.

Thank you for the feedback!

jQuery TextBox Methods - DevExtreme jQuery Documentation v23.2 (2024)
Top Articles
Latest Posts
Article information

Author: Roderick King

Last Updated:

Views: 5491

Rating: 4 / 5 (51 voted)

Reviews: 82% of readers found this page helpful

Author information

Name: Roderick King

Birthday: 1997-10-09

Address: 3782 Madge Knoll, East Dudley, MA 63913

Phone: +2521695290067

Job: Customer Sales Coordinator

Hobby: Gunsmithing, Embroidery, Parkour, Kitesurfing, Rock climbing, Sand art, Beekeeping

Introduction: My name is Roderick King, I am a cute, splendid, excited, perfect, gentle, funny, vivacious person who loves writing and wants to share my knowledge and understanding with you.