JavaScript/jQuery Autocomplete Methods
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.
See Also
defaultOptions(rule)
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
DevExpress.ui.dxAutocomplete.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Autocomplete properties
}
});Angular
import Autocomplete from "devextreme/ui/autocomplete";
// ...
export class AppComponent {
constructor () {
Autocomplete.defaultOptions({
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 React, {useEffect} from "react";
import dxAutocomplete from "devextreme/ui/autocomplete";
import Autocomplete from "devextreme-react/autocomplete";
export default function App() {
useEffect(() => {
dxAutocomplete.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Autocomplete properties
}
})
});
return (
<div>
<Autocomplete id="autocomplete1" />
<Autocomplete id="autocomplete2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myAutocomplete").dxAutocomplete("dispose");
$("#myAutocomplete").remove();Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-autocomplete ...
*ngIf="condition">
</dx-autocomplete>Vue
<template>
<DxAutocomplete ...
v-if="condition">
</DxAutocomplete>
</template>
<script>
import DxAutocomplete from 'devextreme-vue/autocomplete';
export default {
components: {
DxAutocomplete
}
}
</script>React
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;See Also
getButton(name)
Gets an instance of a custom action button.
Use the returned button instance to call the Button UI component's methods, for example, focus():
jQuery
const myCustomButton = $("#autocompleteContainer").dxAutocomplete("getButton", "myCustomButton");
myCustomButton.focus();Angular
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
<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
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.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout
- Data Layer - Overview
- Data Layer - DataSource Examples
getInstance(element)
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);See Also
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a EventObject 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.