Vue Autocomplete 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.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

blur()

Removes focus from the input element.

jQuery

Call Methods

Angular

Call Methods

Vue

Call Methods

React

Call Methods

focus

content()

Gets the popup window's content.

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

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

jQuery

JavaScript

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

Angular

TypeScript

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

Vue

<template>
    <div>
        <DxAutocomplete id="autocomplete1" />
        <DxAutocomplete id="autocomplete2" />
    </div>
</template>
<script>
import DxAutocomplete from "devextreme-vue/autocomplete";
import Autocomplete from "devextreme/ui/autocomplete";

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

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

React

import dxAutocomplete from "devextreme/ui/autocomplete";
import Autocomplete from "devextreme-react/autocomplete";

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

export default function App() {
    return (
        <div>
            <Autocomplete id="autocomplete1" />
            <Autocomplete id="autocomplete2" />
        </div>
    )
}

dispose()

Disposes of all the resources allocated to the Autocomplete instance.

jQuery

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

JavaScript

$("#myAutocomplete").dxAutocomplete("dispose");
$("#myAutocomplete").remove();

Angular

Use conditional rendering instead of this method:

app.component.html

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

Vue

Use conditional rendering instead of this method:

App.vue

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

<script>
import DxAutocomplete from 'devextreme-vue/autocomplete';

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

React

Use conditional rendering instead of this method:

App.js

import React from 'react';

import Autocomplete from 'devextreme-react/autocomplete';

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

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

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

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

Angular

app.component.ts

app.component.html

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

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

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

<dx-autocomplete #autocompleteRef ... >
</dx-autocomplete>

Vue

App.vue

<template>
    <DxAutocomplete ...
        :ref="autocompleteRef">
    </DxAutocomplete>
</template>

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

import DxAutocomplete from 'devextreme-vue/autocomplete';

export default {
    components: {
        DxAutocomplete
    },

    data() {
        return {
            autocompleteRef
        }
    },

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

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

React

App.js

import React from 'react';

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

import Autocomplete from 'devextreme-react/autocomplete';

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

        this.autocompleteRef = React.createRef();

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

    get autocomplete() {
        return this.autocompleteRef.current.instance;
    }

    render() {
        return (
            <Autocomplete ...
                ref={this.autocompleteRef}>
            </Autocomplete>
        );
    }
}
export default App;

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE

This method returns the DataSource instance even if the UI component's dataSource property was given a simple array.

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

// Modular approach
import Autocomplete from "devextreme/ui/autocomplete";
...
let element = document.getElementById("myAutocomplete");
let instance = Autocomplete.getInstance(element) as Autocomplete;

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