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

jQuery

JavaScript

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

Angular

TypeScript

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

Vue

<template>
    <div>
        <DxColorBox id="colorBox1" />
        <DxColorBox id="colorBox2" />
    </div>
</template>
<script>
import DxColorBox from "devextreme-vue/color-box";
import ColorBox from "devextreme/ui/color_box";

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

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

React

import dxColorBox from "devextreme/ui/color_box";
import ColorBox from "devextreme-react/color-box";

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

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

Angular

TypeScript

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

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

Vue

<template>
    <div>
        <DxColorBox />
    </div>
</template>
<script>
import DxColorBox from "devextreme-vue/color-box";
import ColorBox from "devextreme/ui/color_box";

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

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

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

React

import dxColorBox from "devextreme/ui/color_box";
import ColorBox from "devextreme-react/color-box";

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

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

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

dispose()

Disposes of all the resources allocated to the ColorBox instance.

jQuery

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

JavaScript

$("#myColorBox").dxColorBox("dispose");
$("#myColorBox").remove();

Angular

Use conditional rendering instead of this method:

app.component.html

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

Vue

Use conditional rendering instead of this method:

App.vue

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

<script>
import DxColorBox from 'devextreme-vue/color-box';

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

React

Use conditional rendering instead of this method:

App.js

import React from 'react';

import ColorBox from 'devextreme-react/color-box';

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

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

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

field()

Gets the UI component's <input> 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

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

Angular

app.component.ts

app.component.html

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

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

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

<dx-color-box #colorBoxRef ... >
</dx-color-box>

Vue

App.vue

<template>
    <DxColorBox ...
        :ref="colorBoxRef">
    </DxColorBox>
</template>

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

import DxColorBox from 'devextreme-vue/color-box';

export default {
    components: {
        DxColorBox
    },

    data() {
        return {
            colorBoxRef
        }
    },

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

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

React

App.js

import React from 'react';

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

import ColorBox from 'devextreme-react/color-box';

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

        this.colorBoxRef = React.createRef();

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

    get colorBox() {
        return this.colorBoxRef.current.instance();
    }

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

// Modular approach
import ColorBox from "devextreme/ui/color_box";
...
let element = document.getElementById("myColorBox");
let instance = ColorBox.getInstance(element) as ColorBox;

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