Configuration

An object defining configuration properties for the Lookup UI component.

See Also

accessKey

Specifies the shortcut key that sets focus on the UI component.

Type:

String

Default Value: null

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

activeStateEnabled

Specifies whether or not the UI component changes its state when interacting with a user.

Type:

Boolean

Default Value: true

This property is used when the UI component is displayed on a platform whose guidelines include the active state change for UI components.

animation Deprecated

Use the dropDownOptions option instead.

Configures UI component visibility animations. This object contains two fields: show and hide.

Type:

Object

Default Value: undefined

applyButtonText

The text displayed on the Apply button.

Type:

String

Default Value: 'OK'

applyValueMode

Specifies the way an end-user applies the selected value.

Type:

String

Default Value: 'instantly'
Accepted Values: 'instantly' | 'useButtons'

The property accepts the following values.

  • "useButtons"
    Enables an end-user to apply the selected value or cancel the selection using the Apply and Cancel buttons respectively.

  • "instantly"
    Applies the selected value immediately after a user clicks the required value in the drop-down menu. To cancel the selection, click outside the drop-down menu.

Use the EditorApplyValueMode enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Instantly and UseButtons.

cancelButtonText

The text displayed on the Cancel button.

Type:

String

Default Value: 'Cancel'

cleanSearchOnOpening

Specifies whether or not the UI component cleans the search box when the popup window is displayed.

Type:

Boolean

Default Value: true

clearButtonText

The text displayed on the Clear button.

Type:

String

Default Value: 'Clear'

closeOnOutsideClick Deprecated

Use the dropDownOptions option instead.

Specifies whether to close the drop-down menu if a user clicks outside it.

Type:

Boolean

|

Function

Return Value:

Boolean

true if the menu should be closed; otherwise false.

Default Value: false, true (Material)

dataSource

Binds the UI component to data.

If you use DevExtreme ASP.NET MVC Controls, refer to the Bind Controls to Data article.

The Lookup works with collections of objects or string, number, or boolean values.

Depending on your data source, bind the Lookup to data as follows. In each case, also specify the valueExpr, displayExpr, or both if the data source provides objects.

  • Data Array
    Assign the array to the dataSource option.

  • Read-Only Data in JSON Format
    Set the dataSource property to the URL of a JSON file or service that returns JSON data.

  • OData
    Implement an ODataStore.

  • Web API, PHP, MongoDB
    Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:

    Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.

    jQuery
    JavaScript
    $(function() {
        let serviceUrl = "https://url/to/my/service";
        $("#lookupContainer").dxLookup({
            // ...
            dataSource: DevExpress.data.AspNet.createStore({
                key: "ID",
                loadUrl: serviceUrl + "/GetAction",
                insertUrl: serviceUrl + "/InsertAction",
                updateUrl: serviceUrl + "/UpdateAction",
                deleteUrl: serviceUrl + "/DeleteAction"
            })
        })
    });
    Angular
    app.component.ts
    app.component.html
    app.module.ts
    import { Component } from '@angular/core';
    import CustomStore from 'devextreme/data/custom_store';
    import { createStore } from 'devextreme-aspnet-data-nojquery';
    
    @Component({
        selector: 'app-root',
        templateUrl: './app.component.html',
        styleUrls: ['./app.component.css']
    })
    export class AppComponent {
        store: CustomStore;
        constructor() {
            let serviceUrl = "https://url/to/my/service";
            this.store = createStore({
                key: "ID",
                loadUrl: serviceUrl + "/GetAction",
                insertUrl: serviceUrl + "/InsertAction",
                updateUrl: serviceUrl + "/UpdateAction",
                deleteUrl: serviceUrl + "/DeleteAction"
            })
        }
    }
    <dx-lookup ...
        [dataSource]="store">
    </dx-lookup>
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxLookupModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxLookupModule
        ],
        providers: [],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue
    App.vue
    <template> 
        <DxLookup ...
            :data-source="store" />
    </template>
    
    <script>
    import 'devextreme/dist/css/dx.common.css';
    import 'devextreme/dist/css/dx.light.css';
    
    import CustomStore from 'devextreme/data/custom_store';
    import { createStore } from 'devextreme-aspnet-data-nojquery';
    import { DxLookup } from 'devextreme-vue/lookup';
    
    export default {
        components: {
            DxLookup
        },
        data() {
            const serviceUrl = "https://url/to/my/service";
            const store = createStore({
                key: "ID",
                loadUrl: serviceUrl + "/GetAction",
                insertUrl: serviceUrl + "/InsertAction",
                updateUrl: serviceUrl + "/UpdateAction",
                deleteUrl: serviceUrl + "/DeleteAction"
            });
            return {
                store
            }
        }
    }
    </script>
    React
    App.js
    import React from 'react';
    import 'devextreme/dist/css/dx.common.css';
    import 'devextreme/dist/css/dx.light.css';
    
    import CustomStore from 'devextreme/data/custom_store';
    import { createStore } from 'devextreme-aspnet-data-nojquery';
    import Lookup from 'devextreme-react/lookup';
    
    const serviceUrl = "https://url/to/my/service";
    const store = createStore({
        key: "ID",
        loadUrl: serviceUrl + "/GetAction",
        insertUrl: serviceUrl + "/InsertAction",
        updateUrl: serviceUrl + "/UpdateAction",
        deleteUrl: serviceUrl + "/DeleteAction"
    });
    
    class App extends React.Component {
        render() {
            return (
                <Lookup ...
                    dataSource={store} />
            );
        }
    }
    export default App;
  • Any other data source
    Implement a CustomStore.

Regardless of the data source on the input, the Lookup always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.

NOTE

Review the following notes about data binding:

  • Do not specify the items property if you specified the dataSource, and vice versa.

  • Data field names cannot be equal to this and should not contain the following characters: ., :, [, and ].

  • The stores and DataSource have methods to process and update data. However, the methods do not allow you to perform particular tasks (for example, replace the entire dataset, reconfigure data access at runtime). For such tasks, create a new array, store, or DataSource and assign it to the dataSource property as shown in the articles about changing properties in jQuery, Angular, React, and Vue.

deferRendering

Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately.

Type:

Boolean

Default Value: true

disabled

Specifies whether the UI component responds to user interaction.

Type:

Boolean

Default Value: false

displayExpr

Specifies the data field whose values should be displayed.

Type:

String

|

Function

Function parameters:
item:

Object

The current item's data object.

Return Value:

String

The displayed value.

Default Value: undefined

Set this property to the name of a data field that provides displayed values...

displayExpr: "name"

... or to a function that returns the displayed value:

displayExpr: function(item) {
    // "item" can be null
    return item && 'ID: ' + item.id + ', Name: ' + item.name;
}

Leave this property unspecified or set it to this if the data source contains primitives.

See Also

displayValue

Returns the value currently displayed by the UI component.

Type:

String

Read-only
Default Value: undefined

The value you pass to this property does not affect UI component behavior. Pass an observable variable to this property to get the value currently displayed by the UI component.

dropDownCentered

Specifies whether to vertically align the drop-down menu so that the selected item is in its center. Applies only in Material Design themes.

Type:

Boolean

Default Value: false, true (Material)

The drop-down menu can be displayed under the input field (dropDownCentered is false) or over it and centered on the selected item (dropDownCentered is true). The following live example illustrates the difference:

dropDownOptions

Configures the drop-down field.

Default Value: {}

Refer to the Popover configuration for information on properties that you can specify in this object.

NOTE
In Angular and Vue, the nested component that configures the dropDownOptions property does not support event bindings and two-way property bindings.

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#lookupContainer").dxLookup({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-lookup ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-lookup>
import { DxLookupModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxLookupModule
    ],
    // ...
})
Vue
App.vue
<template>
    <DxLookup ...
        :element-attr="lookupAttributes">
    </DxLookup>
</template>

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

export default {
    components: {
        DxLookup
    },
    data() {
        return {
            lookupAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>
React
App.js
import React from 'react';

import Lookup from 'devextreme-react/lookup';

class App extends React.Component {
    lookupAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <Lookup ...
                elementAttr={this.lookupAttributes}>
            </Lookup>
        );
    }
}
export default App;

fieldComponent

An alias for the fieldTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

fieldRender

An alias for the fieldTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

fieldTemplate

Specifies a custom template for the input field.

Type:

template

Template Data:

Object

The selected item's data.

Default Name: null

focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.

Type:

Boolean

Default Value: false, true (desktop)

fullScreen Deprecated

Use the dropDownOptions option instead.

A Boolean value specifying whether or not to display the lookup in full-screen mode.

Type:

Boolean

Default Value: false, true (iPhone)

groupComponent

An alias for the groupTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

grouped

A Boolean value specifying whether or not to group UI component items.

Type:

Boolean

Default Value: false

If this property is set to true, the object assigned to the items property should include key and items properties. The key property specifies the group caption in the list. The items property represents an array listing group items.

NOTE
Only one-level grouping is supported.

View Demo

groupRender

An alias for the groupTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

groupTemplate

Specifies a custom template for group captions.

Type:

template

Template Data:

Object

The current group's data.

Default Name: 'group'

height

Specifies the UI component's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's height.

Default Value: undefined

This property accepts a value of one of the following types:

  • Number
    The height in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "80%", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

hint

Specifies text for a hint that appears when a user pauses on the UI component.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.

Type:

Boolean

Default Value: true

inputAttr

Specifies the attributes to be passed on to the underlying HTML element.

Type:

Object

Default Value: {}

jQuery
$(function(){
    $("#lookupContainer").dxLookup({
        // ...
        inputAttr: {
            id: "inputId"
        }
    });
});
Angular
HTML
TypeScript
<dx-lookup ...
    [inputAttr]="{ id: 'inputId' }">
</dx-lookup>
import { DxLookupModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxLookupModule
    ],
    // ...
})
Vue
App.vue
<template>
    <DxLookup
        :input-attr="inputAttr"
    />
</template>

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

import DxLookup from 'devextreme-vue/lookup';

export default {
    components: {
        DxLookup
    },
    data() {
        return {
            inputAttr: { id: 'inputId' }
        }
    }
}
</script>
React
App.js
import 'devextreme/dist/css/dx.light.css';

import Lookup from 'devextreme-react/lookup';

const inputAttr = { id: 'inputId' };

export default function App() {
    return (
        <Lookup
            inputAttr={inputAttr}
        />
    );
}
ASP.NET MVC Controls
Razor C#
Razor VB
@(Html.DevExtreme().Lookup()
    .InputAttr("id", "inputId")
    // ===== or =====
    .InputAttr(new {
        @id = "inputId"
    })
    // ===== or =====
    .InputAttr(new Dictionary<string, object>() {
        { "id", "inputId" }
    })
)
@(Html.DevExtreme().Lookup() _
    .InputAttr("id", "inputId")
    ' ===== or =====
    .InputAttr(New With {
        .id = "inputId"
    })
    ' ===== or =====
    .InputAttr(New Dictionary(Of String, Object) From {
        { "id", "inputId" }
    })
)

isValid

Specifies or indicates whether the editor's value is valid.

Type:

Boolean

Default Value: true

NOTE
When you use async rules, isValid is true if the status is "pending" or "valid".
See Also

itemComponent

An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

itemRender

An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

items[]

An array of items displayed by the UI component.

The items array can contain:

  • Objects with fields described in this section
  • Objects with any other fields. In this case, specify the itemTemplate.

If you need to update the UI component items, reassign the entire items array as shown in the following example:

JavaScript
lookupInstance.option('items', newItems);

As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores provide an API that allows you to update individual items without reassigning the entire item collection.

NOTE
Do not use the items property if you use dataSource, and vice versa.

itemTemplate

Specifies a custom template for items.

Type:

template

Template Data:

Object

The current item's data.

Default Name: 'item'

minSearchLength

The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true.

Type:

Number

Default Value: 0

name

The value to be assigned to the name attribute of the underlying HTML element.

Type:

String

Default Value: ''

Specify this property if the UI component lies within an HTML form that will be submitted.

If you configure the UI component as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control, use this property to bind the UI component to a model property. If this model property contains Data Annotation validation attributes, you get the client-side validation enabled by default.

nextButtonText

The text displayed on the button used to load the next page from the data source.

Type:

String

Default Value: 'More'

noDataText

The text or HTML markup displayed by the UI component if the item collection is empty.

Type:

String

Default Value: 'No data to display'

onClosed

A function that is executed once the drop-down editor is closed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Lookup

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onContentReady

A function that is executed when the UI component's content is ready and each time the content is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Lookup

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only when using Knockout.

Default Value: null

If data displayed by the UI component is specified using a DataSource instance, the contentReady event fires each time the load() method of the DataSource instance is called as well as when UI component content is ready. In this case, when you create the UI component, the contentReady event is raised twice: when the UI component's content is ready (at this moment, the UI component does not display items) and when the DataSource is loaded (the UI component displays the loaded items).

onDisposing

A function that is executed before the UI component is disposed of.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Lookup

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if you use Knockout.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Lookup

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

See Also

onItemClick

A function that is executed when a list item is clicked or tapped.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Lookup

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

itemData

Object

The clicked item's data.

itemElement

Object

The item's container.

itemIndex

Number

|

Object

The clicked item's index. If the UI component items are grouped, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onOpened

A function that is executed once the drop-down editor is opened.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Lookup

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onOptionChanged

A function that is executed after a UI component property is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Lookup

The UI component's instance.

fullName

String

The path to the modified property that includes all parent properties.

name

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.

value any

The modified property's new value.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if you use Knockout.

Default Value: null

The following example shows how to subscribe to component property changes:

jQuery
index.js
$(function() {
    $("#lookupContainer").dxLookup({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-lookup ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-lookup>
import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}
import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxLookupModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxLookupModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  
Vue
App.vue
<template> 
    <DxLookup ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script> 
import 'devextreme/dist/css/dx.common.css'; 
import 'devextreme/dist/css/dx.light.css'; 
import DxLookup from 'devextreme-vue/lookup'; 

export default { 
    components: { 
        DxLookup
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 
React
App.js
import React from 'react'; 
import 'devextreme/dist/css/dx.common.css'; 
import 'devextreme/dist/css/dx.light.css'; 

import Lookup from 'devextreme-react/lookup'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <Lookup ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

onPageLoading

A function that is executed before the next page is loaded.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Lookup

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

See Also

onPullRefresh

A function that is executed when the "pull to refresh" gesture is performed on the drop-down item list. Supported on mobile devices only.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Lookup

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

Default Value: null

onScroll

A function that is executed on each scroll gesture performed on the drop-down item list.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Lookup

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

reachedBottom

Boolean

Indicates whether the container's bottom boundary is reached.

reachedLeft

Boolean

Indicates whether the container's left boundary is reached.

reachedRight

Boolean

Indicates whether the container's right boundary is reached.

reachedTop

Boolean

Indicates whether the container's top boundary is reached.

scrollOffset

Object

The current scroll offset in the following format { top: topOffset, left: leftOffset }.

Default Value: null

onSelectionChanged

A function that is executed when a list item is selected or selection is canceled.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Lookup

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

selectedItem

Object

The selected item's data.

Default Value: null

onTitleRendered Deprecated

Use the dropDownOptions option instead.

A function that is executed when the drop-down list's title is rendered.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Lookup

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

Object

Model data. Available only if Knockout is used.

titleElement

HTMLElement | jQuery

The title's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

onValueChanged

A function that is executed after the UI component's value is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Lookup

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery. This field is undefined if the value is changed programmatically.

model

Object

Model data. Available only if Knockout is used.

previousValue

Object

The UI component's previous value.

value

Object

The UI component's new value.

Default Value: null

opened

Specifies whether or not the drop-down editor is displayed.

Type:

Boolean

Default Value: false
Raised Events: opened, closed

pageLoadingText

Specifies the text shown in the pullDown panel, which is displayed when the UI component is scrolled to the bottom.

Type:

String

Default Value: 'Loading...'

pageLoadMode

Specifies whether the next page is loaded when a user scrolls the UI component to the bottom or when the "next" button is clicked.

Type:

String

Default Value: 'scrollBottom'
Accepted Values: 'nextButton' | 'scrollBottom'

Use the ListPageLoadMode enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: ScrollBottom and NextButton.

placeholder

The text displayed by the UI component when nothing is selected.

Type:

String

Default Value: 'Select'

popupHeight Deprecated

Use the dropDownOptions option instead.

Specifies the popup element's height. Applies only if fullScreen is false.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The popup element's height.

Default Value: function() { return $(window).height() * 0.8 }, 'auto' (desktop, iPad)

popupWidth Deprecated

Use the dropDownOptions option instead.

Specifies the popup element's width. Applies only if fullScreen is false.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The popup element's width.

Default Value: function() {return $(window).width() * 0.8 }, function() { return Math.min($(window).width(), $(window).height()) * 0.4; } (iPad)

position Deprecated

Use the dropDownOptions option instead.

An object defining UI component positioning properties.

Default Value: undefined, { my: 'left top', at: 'left top', of: lookupContainer } (Material)

pulledDownText

Specifies the text displayed in the pullDown panel when the UI component is pulled below the refresh threshold.

Type:

String

Default Value: 'Release to refresh...'

pullingDownText

Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold.

Type:

String

Default Value: 'Pull down to refresh...'

pullRefreshEnabled

A Boolean value specifying whether or not the UI component supports the "pull down to refresh" gesture.

Type:

Boolean

Default Value: false

If the property is set to true, the UI component data is refreshed each time you pull down and release UI component contents.

NOTE
The "pull down to refresh" gesture is not supported by desktop browsers. You can use it only on mobile devices.

refreshingText

Specifies the text displayed in the pullDown panel while the UI component is being refreshed.

Type:

String

Default Value: 'Refreshing...'

rtlEnabled

Switches the UI component to a right-to-left representation.

Type:

Boolean

Default Value: false

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
DevExpress.config({
    rtlEnabled: true
});
See Also

searchEnabled

Specifies whether the search box is visible.

Type:

Boolean

Default Value: true, false (Material)

NOTE
Searching works with source data of plain structure only. Subsequently, data can be transformed to hierarchical structure using the DataSource's group property.
See Also

searchExpr

Specifies the name of a data source item field or an expression whose value is compared to the search criterion.

Type:

getter

|

Array<getter>

Default Value: null

In most cases, you should pass the name of a field by whose value data items are searched. If you need to search elements by several field values, assign an array of field names to this property.

JavaScript
searchExpr: ["firstName", "lastName"]

For more information on searching, refer to the Search Api section of the Data Layer article. For information on getters, refer to the Getters and Setters section of the Data Layer article.

searchMode

Specifies a comparison operation used to search UI component items.

Type:

String

Default Value: 'contains'
Accepted Values: 'contains' | 'startswith'

Use the DropDownSearchMode enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Contains and StartsWith.

searchPlaceholder

The text that is provided as a hint in the lookup's search bar.

Type:

String

Default Value: 'Search'

searchTimeout

Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed.

Type:

Number

Default Value: 500

selectedItem

Gets the currently selected item.

Type: any
Read-only
Default Value: null

shading Deprecated

Use the dropDownOptions option instead.

Specifies whether to shade the container when the lookup is active. Applies only if usePopover is false.

Type:

Boolean

Default Value: true

showCancelButton

Specifies whether to display the Cancel button in the lookup window.

Type:

Boolean

Default Value: true, false (Material)

The Cancel button cancels the attempt to change the lookup UI component value.

showClearButton

Specifies whether to display the Clear button in the lookup window.

Type:

Boolean

Default Value: false

The Clear button calls the reset method which resets the value property to its default value (null). The lookup window closes and the text specified by the placeholder property is shown in the lookup editor.

showDataBeforeSearch

Specifies whether or not the UI component displays unfiltered values until a user types a number of characters exceeding the minSearchLength property value.

Type:

Boolean

Default Value: false

If this property is disabled, the UI component does not display values until the number of typed characters exceeds the minSearchLength value, otherwise it displays all values regardless of the specified filtering condition.

showPopupTitle Deprecated

Use the dropDownOptions option instead.

A Boolean value specifying whether or not to display the title in the popup window.

Type:

Boolean

Default Value: true, false (Material)

stylingMode

Specifies how the UI component's text field is styled.

Type:

String

Default Value: 'outlined', 'underlined' (Material)
Accepted Values: 'outlined' | 'underlined' | 'filled'

The following styles are available:

Text Editor Styling Modes

Use the EditorStylingMode enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Outlined, Underlined, and Filled.

You can also use the global editorStylingMode setting to specify how the text fields of all editors in your application are styled.

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

text

The read-only property that holds the text displayed by the UI component input element.

Type:

String

Read-only

title Deprecated

Use the dropDownOptions option instead.

The title of the lookup window.

Type:

String

Default Value: ''

titleComponent Deprecated

An alias for the titleTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

titleRender Deprecated

An alias for the titleTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

titleTemplate Deprecated

Use the dropDownOptions option instead.

Specifies a custom template for the title.

Type:

template

Template Data: undefined
Default Name: 'title'

useNativeScrolling

Specifies whether or not the UI component uses native scrolling.

Type:

Boolean

Default Value: true, false (desktop except Mac)

usePopover

Specifies whether to show lookup contents in the Popover UI component.

Type:

Boolean

Default Value: false, true (desktop, iOS), false (Material)

Lookup contents can be displayed in a Popover only if dropDownOptions.fullScreen is disabled. Otherwise, lookup contents are displayed within the Popup UI component.

Material Design themes always use the Popup UI component, ignoring the usePopover property.

validationError

Information on the broken validation rule. Contains the first item from the validationErrors array.

Type:

Object

Default Value: null

See Also

validationErrors

An array of the validation rules that failed.

Type:

Array<Object>

Default Value: null

validationMessageMode

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.

Type:

String

Default Value: 'auto'
Accepted Values: 'always' | 'auto'

The following property values are possible:

  • auto
    The tooltip with the message is displayed when the editor is in focus.
  • always
    The tooltip with the message is not hidden when the editor loses focus.

Use the ValidationMessageMode enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Auto and Always.

validationStatus

Indicates or specifies the current validation status.

Type:

String

Default Value: 'valid'
Accepted Values: 'valid' | 'invalid' | 'pending'

The following table illustrates the validation status indicators:

validationStatus Indicator
"pending" DevExtreme editor validation status: pending
"valid" DevExtreme editor validation status: valid
"invalid" DevExtreme editor validation status: invalid

value

Specifies the currently selected value. May be an object if dataSource contains objects and valueExpr is not set.

Type: any
Default Value: null
Raised Events: valueChanged

valueChangeEvent

Specifies the DOM events after which the UI component's search results should be updated.

Type:

String

Default Value: 'input change keyup'

This property accepts a single event name or several names separated by spaces.

The recommended events are "keyup", "blur", "change", "input", and "focusout", but you can use other events as well.

See Also

valueExpr

Specifies which data field provides unique values to the UI component's value.

Type:

String

|

Function

Function parameters:
item:

Object

The current item's data object.

Return Value:

String

|

Number

|

Boolean

A unique item identifier.

Default Value: 'this'

Always set this property if the dataSource contains objects. Alternatively, you can specify the key in the store.

NOTE
You cannot specify valueExpr as a function when the UI component is bound to a remote data source. This is because valueExpr is used in a filter the UI component sends to the server when querying data. Functions with custom logic cannot be serialized for this filter.
See Also

visible

Specifies whether the UI component is visible.

Type:

Boolean

Default Value: true

width

Specifies the UI component's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's width.

Default Value: undefined

This property accepts a value of one of the following types:

  • Number
    The width in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }

wrapItemText

Specifies whether text that exceeds the drop-down list width should be wrapped.

Type:

Boolean

Default Value: false