Angular NumberBox Methods

This section describes the members used to manipulate the UI component.

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.

blur()

Removes focus from the input element.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

focus

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 \| Array<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.

Name

Type

Description

device

Device

|

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

jQuery

JavaScript

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

Angular

TypeScript

import NumberBox, { Properties } from "devextreme/ui/number_box";
// ...
export class AppComponent {
    constructor () {
        NumberBox.defaultOptions<Properties>({
            device: { deviceType: "desktop" },
            options: {
                // Here go the NumberBox properties
            }
        });
    }
}

Vue

<template>
    <div>
        <DxNumberBox id="numberBox1" />
        <DxNumberBox id="numberBox2" />
    </div>
</template>
<script>
import DxNumberBox from "devextreme-vue/number-box";
import NumberBox from "devextreme/ui/number_box";

NumberBox.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the NumberBox properties
    }
});

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

React

import dxNumberBox from "devextreme/ui/number_box";
import NumberBox from "devextreme-react/number-box";

dxNumberBox.defaultOptions({
    device: { deviceType: "desktop" },
    options: {
        // Here go the NumberBox properties
    }
});

export default function App() {
    return (
        <div>
            <NumberBox id="numberBox1" />
            <NumberBox id="numberBox2" />
        </div>
    )
}

dispose()

Disposes of all the resources allocated to the NumberBox instance.

jQuery

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

JavaScript

$("#myNumberBox").dxNumberBox("dispose");
$("#myNumberBox").remove();

Angular

Use conditional rendering instead of this method:

app.component.html

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

Vue

Use conditional rendering instead of this method:

App.vue

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

<script>
import DxNumberBox from 'devextreme-vue/number-box';

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

React

Use conditional rendering instead of this method:

App.js

import React from 'react';

import NumberBox from 'devextreme-react/number-box';

function DxNumberBox(props) {
    if (!props.shouldRender) {
        return null;
    }

    return (
        <NumberBox ... >    
        </NumberBox>
    );
}

class App extends React.Component {
    render() {
        return (
            <DxNumberBox 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.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.

Main article: beginUpdate()

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

focus()

Sets focus to the input element representing the UI component.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

getButton(name)

Gets an instance of a custom action button.

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 = $("#numberBoxContainer").dxNumberBox("getButton", "myCustomButton");
myCustomButton.focus();

Angular

app.component.ts

app.component.html

import { Component, ViewChild } from '@angular/core';
import { DxNumberBoxComponent } from 'devextreme-angular';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    @ViewChild('numberBoxRef', { static: false }) numberBox: DxNumberBoxComponent;
    // Prior to Angular 8
    // @ViewChild('numberBoxRef') numberBox: DxNumberBoxComponent;

    setFocus() {
        this.numberBox.instance.getButton('myCustomButton').focus();
    }
}

<dx-number-box #numberBoxRef ... >
</dx-number-box>

Vue

App.vue

<template>
    <DxNumberBox ...
        :ref="numberBoxRef">
    </DxNumberBox>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxNumberBox from 'devextreme-vue/number-box';

export default {
    components: {
        DxNumberBox
    },

    data() {
        return {
            numberBoxRef
        }
    },

    methods: {
        setFocus() {
            this.numberBox.getButton('myCustomButton').focus();
        }
    },

    computed: {
        numberBox: function() {
            return this.$refs[numberBoxRef].instance;
        }
    }
}
</script>

React

App.js

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import NumberBox from 'devextreme-react/number-box';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.numberBoxRef = React.createRef();

        this.setFocus = () => {
            this.numberBox.getButton('myCustomButton').focus();
        };
    }

    get numberBox() {
        return this.numberBoxRef.current.instance;
    }

    render() {
        return (
            <NumberBox ...
                ref={this.numberBoxRef}>
            </NumberBox>
        );
    }
}
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 NumberBox instance found in an element with the myNumberBox ID:

// Modular approach
import NumberBox from "devextreme/ui/number_box";
...
let element = document.getElementById("myNumberBox");
let instance = NumberBox.getInstance(element) as NumberBox;

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