React TextBox Methods

The component's default device options.

Object structure:

Name	Type	Description
device	Device \| Array<Device> \| Function	Device parameters. When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.
options	Object	Options to be applied.

Name

Type

Description

device

Device

|

Array<Device>

|

Device parameters.
When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.

options

Options to be applied.

defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the TextBox widget in an application executed on the desktop.

jQuery

JavaScript

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

Angular

TypeScript

import TextBox from "devextreme/ui/text_box";
// ...
export class AppComponent {
    constructor () {
        TextBox.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the TextBox options
            }
        });
    }
}

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 options
    }
});

export default {
    components: {
        DxTextBox
    }
}
</script>

React

import React from "react";
import dxTextBox from "devextreme/ui/text_box";
import TextBox from "devextreme-react/text-box";

class App extends React.Component {
    render () {
        dxTextBox.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the TextBox options
            }
        })
        return (
            <div>
                <TextBox id="textBox1" />
                <TextBox id="textBox2" />
            </div>
        )
    }
}

export default App;

dispose()

Disposes of all the resources allocated to the TextBox instance.

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

JavaScript

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

Use this method only if the widget was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:

Angular

app.component.html

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

Vue

App.vue

<template>
    <DxTextBox ...
        v-if="condition">
    </DxTextBox>
</template>

<script>
import DxTextBox from 'devextreme-vue/text-box';

export default {
    components: {
        DxTextBox
    }
}
</script>

React

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 widget element.

Return Value:

HTMLElement | jQuery

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

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

focus()

Sets focus to the input element representing the widget.

getButton(name)

Gets an instance of a custom action button.

Parameters:

name:

The button's name.

Return Value:

Button

| undefined

The Button widget's instance.

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

jQuery

index.js

var 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.common.css';
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.common.css';
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 widget found using its DOM node.

Parameters:

element:

Element

|

jQuery

The widget's container.

Return Value:

The widget's instance.

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

// Modular approach
import TextBox from "devextreme/ui/text_box";
...
let element = document.getElementById("myTextBox");
let instance = TextBox.getInstance(element) as TextBox;

// Non-modular approach
let element = document.getElementById("myTextBox");
let instance = DevExpress.ui.dxTextBox.getInstance(element);

instance()

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

Return Value:

This widget's instance.

off(eventName)

Detaches all event handlers from a single event.

Parameters:

eventName:

The event's name.

Return Value:

The object for which this method is called.

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

on(eventName, eventHandler)

Subscribes to an event.

Parameters:

eventName:

The event's name.

eventHandler:

The event's handler.

Return Value:

The object for which this method is called.

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

on(events)

Subscribes to events.

Parameters:

events:

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

Return Value:

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.

option()

Gets all widget options.

Return Value:

The widget's options.

option(optionName)

Gets the value of a single option.

Parameters:

optionName:

The option's name or full path.

Return Value: any

This option's value.

option(optionName, optionValue)

Updates the value of a single option.

Parameters:

optionName:

The option's name or full path.

optionValue: any

This option's new value.

option(options)

Updates the values of several options.

Parameters:

options:

Options with their new values.

registerKeyHandler(key, handler)

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

Parameters:

key:

A 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.

repaint()

Repaints the widget without reloading data. Call it to update the widget's markup.

reset()

Resets the value option to the default value.

resetOption(optionName)

Resets an option to its default value.

Parameters:

optionName: