JavaScript/jQuery Lookup Methods

This section describes the methods that control the Lookup widget.

See Also

beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.

The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.

See Also

blur()

Removes focus from the input element.

See Also

close()

Closes the drop-down editor.

See Also

content()

Gets the popup window's content.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

See Also

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

Parameters:
rule:

Object

The component's default device options.

Object structure:
Name Type Description
device

Device

|

Array<Device>

|

Function

Device parameters.
When specifying a function, get information about the current device from the argument. Return true if the options should be applied to the device.
options

Object

Options to be applied.

defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the Lookup widget in an application executed on the desktop.

jQuery
JavaScript
DevExpress.ui.dxLookup.defaultOptions({ 
    device: { deviceType: "desktop" },
    options: {
        // Here go the Lookup options
    }
});
Angular
TypeScript
import Lookup from "devextreme/ui/lookup";
// ...
export class AppComponent {
    constructor () {
        Lookup.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Lookup options
            }
        });
    }
}
Vue
<template>
    <div>
        <DxLookup id="lookup1" />
        <DxLookup id="lookup2" />
    </div>
</template>
<script>
import DxLookup from "devextreme-vue/lookup";
import Lookup from "devextreme/ui/lookup";

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

export default {
    components: {
        DxLookup
    }
}
</script>
React
import React from "react";
import dxLookup from "devextreme/ui/lookup";
import Lookup from "devextreme-react/lookup";

class App extends React.Component {
    render () {
        dxLookup.defaultOptions({
            device: { deviceType: "desktop" },
            options: {
                // Here go the Lookup options
            }
        })
        return (
            <div>
                <Lookup id="lookup1" />
                <Lookup id="lookup2" />
            </div>
        )
    }
}

export default App;

dispose()

Disposes of all the resources allocated to the Lookup instance.

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

JavaScript
$("#myLookup").dxLookup("dispose");
$("#myLookup").remove();

Use this method only if the widget was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:

Angular
app.component.html
<dx-lookup ...
    *ngIf="condition">
</dx-lookup>
Vue
App.vue
<template>
    <DxLookup ...
        v-if="condition">
    </DxLookup>
</template>

<script>
import DxLookup from 'devextreme-vue/lookup';

export default {
    components: {
        DxLookup
    }
}
</script>
React
App.js
import React from 'react';

import Lookup from 'devextreme-react/lookup';

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

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

class App extends React.Component {
    render() {
        return (
            <DxLookup shouldRender="condition" />
        );
    }
}
export default App;
See Also

element()

Gets the root widget element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

See Also

endUpdate()

Refreshes the widget after a call of the beginUpdate() method.

Main article: beginUpdate()

See Also

field()

Gets the widget's <input> element.

Return Value:

HTMLElement | jQuery

An HTML element or a jQuery element when you use jQuery.

See Also

focus()

Sets focus to the input element representing the widget.

See Also

getDataSource()

Gets the DataSource instance.

Return Value:

DataSource

The DataSource instance.

NOTE
This method returns the DataSource instance even if the widget's dataSource option was given a simple array.
See Also

getInstance(element)

Gets the instance of a widget found using its DOM node.

Parameters:
element:

Element

|

jQuery

The widget's container.

Return Value:

Object

The widget's instance.

getInstance is a static method that the widget class supports. The following code demonstrates how to get the Lookup instance found in an element with the myLookup ID:

// Modular approach
import Lookup from "devextreme/ui/lookup";
...
let element = document.getElementById("myLookup");
let instance = Lookup.getInstance(element) as Lookup;

// Non-modular approach
let element = document.getElementById("myLookup");
let instance = DevExpress.ui.dxLookup.getInstance(element);
See Also

instance()

Gets the widget's instance. Use it to access other methods of the widget.

Return Value:

Lookup

This widget's instance.

See Also

off(eventName)

Detaches all event handlers from a single event.

Parameters:
eventName:

String

The event's name.

Return Value:

Lookup

The object for which this method is called.

See Also

off(eventName, eventHandler)

Detaches a particular event handler from a single event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

Lookup

The object for which this method is called.

See Also

on(eventName, eventHandler)

Subscribes to an event.

Parameters:
eventName:

String

The event's name.

eventHandler:

Function

The event's handler.

Return Value:

Lookup

The object for which this method is called.

Use this method to subscribe to one of the events listed in the Events section.

See Also

on(events)

Subscribes to events.

Parameters:
events:

Object

Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}

Return Value:

Lookup

The object for which this method is called.

Use this method to subscribe to several events with one method call. Available events are listed in the Events section.

See Also

open()

Opens the drop-down editor.

See Also

option()

Gets all widget options.

Return Value:

Object

The widget's options.

See Also

option(optionName)

Gets the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

Return Value: any

This option's value.

See Also

option(optionName, optionValue)

Updates the value of a single option.

Parameters:
optionName:

String

The option's name or full path.

optionValue: any

This option's new value.

See Also

option(options)

Updates the values of several options.

Parameters:
options:

Object

Options with their new values.

See Also

registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.

Parameters:
key:

String

A key.

handler:

Function

A handler. Accepts the keydown event as the argument. It is a dxEvent 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.

See Also

repaint()

Repaints the widget without reloading data. Call it to update the widget's markup.

See Also

reset()

Resets the value option to the default value.

See Also

resetOption(optionName)

Resets an option to its default value.

Parameters:
optionName:

String

An option's name.

See Also