JavaScript/jQuery Button Methods

This section describes members used to manipulate the UI component.

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.

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.

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

jQuery

JavaScript

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

Angular

TypeScript

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

Vue

<template>
    <div>
        <DxButton id="button1" />
        <DxButton id="button2" />
    </div>
</template>
<script>
import DxButton from "devextreme-vue/button";
import Button from "devextreme/ui/button";

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

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

React

import dxButton from "devextreme/ui/button";
import Button from "devextreme-react/button";

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

export default function App() {
    return (
        <div>
            <Button id="button1" />
            <Button id="button2" />
        </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.dxButton.defaultOptions({ 
        device: deviceConfig,
        options: {
            // Here go the Button properties
        }
    });
});

Angular

TypeScript

import Button, { Properties } from "devextreme/ui/button";
// ...
export class AppComponent {
    constructor () {
        const devicesConfig = [
            { deviceType: 'desktop' },
            { deviceType: 'tablet' },
            { deviceType: 'phone' },
        ];

        devicesConfig.forEach(deviceConfig => {
            Button.defaultOptions<Properties>({
                device: deviceConfig,
                options: {
                    // Here go the Button properties
                }
            });
        });
    }
}

Vue

<template>
    <div>
        <DxButton />
    </div>
</template>
<script>
import DxButton from "devextreme-vue/button";
import Button from "devextreme/ui/button";

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    Button.defaultOptions({
        device: deviceConfig,
        options: {
            // Here go the Button properties
        }
    });
});

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

React

import dxButton from "devextreme/ui/button";
import Button from "devextreme-react/button";

const devicesConfig = [
    { deviceType: 'desktop' },
    { deviceType: 'tablet' },
    { deviceType: 'phone' },
];

devicesConfig.forEach(deviceConfig => {
    dxButton.defaultOptions({
        device: deviceConfig,
        options: {
            // Here go the Button properties
        }
    });
});

export default function App() {
    return (
        <div>
            <Button />
        </div>
    )
}

dispose()

Disposes of all the resources allocated to the Button instance.

jQuery

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

JavaScript

$("#myButton").dxButton("dispose");
$("#myButton").remove();

Angular

Use conditional rendering instead of this method:

app.component.html

<dx-button ...
    *ngIf="condition">
</dx-button>

Vue

Use conditional rendering instead of this method:

App.vue

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

<script>
import DxButton from 'devextreme-vue/button';

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

React

Use conditional rendering instead of this method:

App.js

import React from 'react';

import Button from 'devextreme-react/button';

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

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

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

The beginUpdate() and endUpdate() methods reduce the number of renders in cases where extra rendering can negatively affect performance.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

focus()

Sets focus on the UI component.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

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 Button instance found in an element with the myButton ID:

// Modular approach
import Button from "devextreme/ui/button";
...
let element = document.getElementById("myButton");
let instance = Button.getInstance(element) as Button;

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