Configuration

An object defining configuration options for the Lookup widget.

accessKey

Specifies the shortcut key that sets focus on the widget.

Type:

String

Default Value: null

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

activeStateEnabled

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

Type:

Boolean

Default Value: true

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

Show Example:
AngularJS
Knockout
jQuery

animation

Configures widget 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: 'Done'

Show Example:
AngularJS
Knockout
jQuery

applyValueMode

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

Type:

String

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

The option 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.

When using the widget as an ASP.NET MVC Control, specify this option using the EditorApplyValueMode enum. This enum accepts the following values: Instantly and UseButtons.

attr

Deprecated

Use the inputAttr option instead.

cancelButtonText

The text displayed on the Cancel button.

Type:

String

Default Value: 'Cancel'

Show Example:
AngularJS
Knockout
jQuery

cleanSearchOnOpening

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

Type:

Boolean

Default Value: true

Show Example:
AngularJS
Knockout
jQuery

clearButtonText

The text displayed on the Clear button.

Type:

String

Default Value: 'Clear'

Show Example:
AngularJS
Knockout
jQuery

closeOnOutsideClick

A Boolean value specifying whether or not a widget is closed if a user clicks outside of the overlaying window.

Type:

Boolean

|

function

Return Value:

Boolean

The required option value.

Default Value: false

The function passed to this option enables you to specify a custom condition for widget closing. For instance, you can prevent closing until a user clicks a certain element.

jQuery
JavaScript
$(function () {
    $("#lookupContainer").dxLookup({
        // ...
        closeOnOutsideClick: function(e) {
            return e.target === $("#someElement").get()[0];
        }
    });
});
Angular
TypeScript
HTML
import { DxLookupModule } from 'devextreme-angular';
// ...
export class AppComponent {
    // ...
    closeOnOutsideClick (e) {
        return e.target === document.getElementById("someElement");
    }
}
@NgModule({
     imports: [
         // ...
         DxLookupModule
     ],
     // ...
 })
<dx-lookup ...
    (closeOnOutsideClick)="closeOnOutsideClick($event)">
</dx-lookup>

dataSource

A data source used to fetch data to be displayed by the widget.

Default Value: null

This option accepts one of the following.

  • Array of objects
    A simple JavaScript array containing a collection of plain objects.

  • URL
    A URL to JSON data or to a service returning data in JSON format.

  • DataSource or its configuration object
    A DataSource is an object that provides a handy API for data processing. A DataSource is a stateful object, which means that it saves data processing settings and applies them each time data is loaded. All underlying data access logic of a DataSource is isolated in a Store. A Store provides an API for reading and modifying data. Unlike the DataSource, a Store is a stateless object.

NOTE
If the data source is specified using the dataSource option, use the items option only for reading. Updating data items using the items option may cause unexpected results.

If the Lookup widget works with the data accessed using a DataSource instance wrapping a CustomStore, pay attention to the byKey option of the CustomStore instance, which is required for this widget. This option takes on a function used to get an item by a key.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API. Alternatively, you can implement a custom item template.

Show Example:
AngularJS
Knockout
jQuery

deferRendering

Specifies whether widget content is rendered when the widget is shown or when rendering the widget.

Type:

Boolean

Default Value: true

If this option is set to true, widget content is rendered when showing the widget. Otherwise, widget content is rendered when rendering the widget.

disabled

Specifies whether the widget responds to user interaction.

Type:

Boolean

Default Value: false

Show Example:
AngularJS
Knockout
jQuery

displayExpr

Specifies the name of the data source item field whose value is displayed by the widget.

Type:

String

|

function

Default Value: undefined

If the data source item is a simple object holding a value (string, numeric, Boolean, etc.), assign 'this' to the displayExpr option. If the item is a plain object item, assign the required field name or path to the option.

Show Example:
AngularJS
Knockout
jQuery

displayValue

Returns the value currently displayed by the widget.

Type:

String

Default Value: undefined

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

Show Example:
AngularJS
Knockout
jQuery

dropDownButtonTemplate

Specifies a custom template for the drop-down button.

Type:

template

Function parameters:
buttonData:

Object

An object holding the button data.

Object structure:
text:

String

The button's text.

icon:

String

The button's icon.

contentElement:

Element (jQuery or HTML)

The button's container.

Return Value:

String

|

jQuery

A template name or container.

Default Value: 'dropDownButton'

If you use the Knockout or AngularJS library, you can implement this template with the dxTemplate markup component. The template is in the binding context of the view model. Therefore, you can bind template elements directly to the properties of the view model. To access another binding context from the template, use the Knockout or AngularJS binding variables.

See Also

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Object

Default Value: {}

You can configure this option in an ASP.NET MVC Control as follows:

Razor C#
Razor VB
@(Html.DevExtreme().WidgetName()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)
@(Html.DevExtreme().WidgetName() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

fieldEditEnabled

Deprecated

This option is deprecated, because the functionality controlled by it was not supposed to belong to the Lookup widget. Instead, we suggest that you use the SelectBox widget with the acceptCustomValue option set to true.

fieldTemplate

The template to be used for rendering the widget text field.

Type:

template

Function parameters:
selectedItem:

Object

The selected item's data.

fieldElement:

Element (jQuery or HTML)

The field's container.

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: null

This option enables you to render the widget text field depending on selected item values.

A binding context of a field template is the data source object that corresponds to the currently rendered item.

So, in the Knockout approach, you can bind template elements to the item's fields directly (see the code below). To access another binding context within a field template, use the Knockout binding variables.

In the AngularJS approach, if you need to access the item object's fields within a template, use a variable whose name is assigned to the dx-item-alias directive (see the code below). Add the directive to the widget element to specify an alias to the root object of an item. Without this directive, item object fields are beyond reach. To access another binding context within a field template, use AngularJS binding variables.

AngularJS
HTML
<div data-options="dxTemplate: { name:'myField' }" dx-item-alias="itemObj">
    <div dx-text-box: { value: itemObj.name + ' (' + itemObj.capital + ')' } "></div>
</div>
Knockout
HTML
<div data-options="dxTemplate: { name:'myField' }">
    <div data-bind="dxTextBox: { value: name + ' (' + capital + ')' } "></div>
</div>

View Demo

See Also

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Boolean

Default Value: false
Default for desktop: true

fullScreen

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

Type:

Boolean

Default Value: false
Default for windows phone 8: true
Default for iPhone: true

Show Example:
AngularJS
Knockout
jQuery

grouped

A Boolean value specifying whether or not to group widget items.

Type:

Boolean

Default Value: false

If this option is set to 'true', the object assigned to the items option 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.

groupTemplate

Specifies a custom template for a group caption.

Type:

template

Function parameters:
itemData:

Object

The current group's data.

itemIndex:

Number

The group's index.

itemElement:

Element (jQuery or HTML)

The group's container.

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: 'group'

If you use the Angular, AngularJS or Knockout library, you can implement this template with the dxTemplate markup component. This template's binding context depends on the library you use.

In Angular apps, a group's object and index extend the standard binding context (a component instance). Access the former using the input variable that is declared after the let and before of keywords, and the latter by the variable that is set to the index property.

In AngularJS apps, a group's object and index extend the standard binding context (the scope). Access the former using an alias that you specify in the dx-item-alias directive, and the latter the $index variable. Use AngularJS binding variables if you need to access another binding context from the template.

In Knockout apps, you can bind template elements directly to a group object's fields. Use the $index variable to get the item's index. Use Knockout binding variables if you need to access another binding context from the template.

See Also

height

Specifies the widget's height.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget's height.

Default Value: undefined

This option accepts a value of one of the following types.

  • Number
    The height of the widget in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "80%", "auto", "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 widget.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the widget 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: {}

You can configure this option in an ASP.NET MVC Control as follows:

Razor C#
Razor VB
@(Html.DevExtreme().WidgetName()
    .InputAttr("id", "inputId")
    // ===== or =====
    .InputAttr(new {
        @id = "inputId"
    })
    // ===== or =====
    .InputAttr(new Dictionary<string, object>() {
        { "id", "inputId" }
    })
)
@(Html.DevExtreme().WidgetName() _
    .InputAttr("id", "inputId")
    ' ===== or =====
    .InputAttr(New With {
        .id = "inputId"
    })
    ' ===== or =====
    .InputAttr(New Dictionary(Of String, Object) From {
        { "id", "inputId" }
    })
)

isValid

Specifies whether the editor's value is valid.

Type:

Boolean

Default Value: true

In Knockout apps, you may need to inform a user about an error that occurred during the validation of a view model field. For this purpose, set the editor's isValid option to the isValid value of the dxValidator that validates this field. To show an error message, set the editor's validationError option to the dxValidator's validationError value.

JavaScript
var editorValue = ko.observable("").extend({
    dxValidator: {
        validationRules: [{
            type: 'required',
            message: 'Specify this value'
        }]
    }
});
var viewModel = {
    editorOptions: {
        value: editorValue,
        isValid: editorValue.dxValidator.isValid,
        validationError: editorValue.dxValidator.validationError
    }
};

The editor's isValid and validationError options should also be specified when using a custom validation engine. In this instance, the validation result will be displayed for the editor by the means of the DevExtreme Validation UI.

See Also

items

An array of items displayed by the widget.

Type:

Array<any>

You can use the dataSource option instead. Unlike the items option, the dataSource option can take on the DataSource configuration object as well as a simple array.

NOTE
If you need to modify the data source specified using the items option at runtime, do it only with the help of the items option. Updating data items using the dataSource option may cause unexpected results.

itemTemplate

Specifies a custom template for an item.

Type:

template

Function parameters:
itemData:

Object

The current item's data.

itemIndex:

Number

The current item's index.

itemElement:

Element (jQuery or HTML)

The current item's container.

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: 'item'

If you use the Angular, AngularJS or Knockout library, you can implement this template with the dxTemplate markup component. This template's binding context depends on the library you use.

In Angular apps, an item's object and index extend the standard binding context (a component instance). Access the former using the input variable that is declared after the let and before of keywords, and the latter by the variable that is set to the index property.

In AngularJS apps, an item's object and index extend the standard binding context (the scope). Access the former using an alias that you specify in the dx-item-alias directive, and the latter the $index variable. Use AngularJS binding variables if you need to access another binding context from the template.

In Knockout apps, you can bind template elements directly to an item object's fields. Use the $index variable to get the item's index. Use Knockout binding variables if you need to access another binding context from the template.

See Also
Show Example:
AngularJS
Knockout
jQuery

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 option if the widget lies within an HTML form that will be submitted.

If you configure the widget as an ASP.NET MVC Control, use this option to bind the widget 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 widget if the item collection is empty.

Type:

String

Default Value: 'No data to display'

Show Example:
AngularJS
Knockout
jQuery

onClosed

A handler for the closed event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

Default Value: null

Assign a function to perform a custom action after a drop-down editor has been hidden.

Show Example:
AngularJS
Knockout
jQuery

onContentReady

A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only when using Knockout.

Default Value: null

If data displayed by the widget 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 widget content is ready. In this case, when you create the widget, the contentReady event is raised twice: when the widget's content is ready (at this moment, the widget does not display items) and when the DataSource is loaded (the widget displays the loaded items).

onDisposing

A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

Default Value: null

You cannot access widget elements in this handler because it is executed before they are ready. Use the onContentReady handler instead.

onItemClick

A handler for the itemClick event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

itemData:

Object

The clicked item's data.

itemElement:

Object

The item's container.

itemIndex:

Number

|

Object

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

Default Value: null

Assign a function to perform a custom action when a widget item is clicked.

To navigate to a specific URL when the itemClick event fires, assign that URL directly to this option.

onOpened

A handler for the opened event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

Default Value: null

Assign a function to perform a custom action when the drop-down editor is shown.

Show Example:
AngularJS
Knockout
jQuery

onOptionChanged

A handler for the optionChanged event. Executed after an option of the widget is changed.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onPageLoading

A handler for the pageLoading event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

Default Value: null

Assign a function to perform a custom action before loading the next page in the lookup list if auto-paging is enabled.

onPullRefresh

A handler for the pullRefresh event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

Default Value: null

Assign a function to perform a custom action before the lookup list is refreshed as a result of the "pull down to refresh" gesture.

onScroll

A handler for the scroll event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

scrollOffset:

Object

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

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.

reachedBottom:

Boolean

Indicates whether the container's bottom boundary is reached.

Default Value: null

Assign a function to perform a custom action on each scroll gesture.

onSelectionChanged

A handler for the selectionChanged event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

selectedItem:

Object

The selected item's data.

Default Value: null

Assign a function to perform a custom action when the selection changes.

onTitleRendered

A handler for the titleRendered event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

titleElement:

Element (jQuery or HTML)

The title's container.

Default Value: null

Assign a function to perform a custom action after a collection item title is rendered.

onValueChanged

A handler for the valueChanged event.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if Knockout is used.

value:

Object

The widget's new value.

previousValue:

Object

The widget's previous value.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

Assign a function to perform a custom action when the editor value changes.

Use the selectedItem field of the argument object passed to the onSelectionChanged event handler to access selected item.

View Demo

Show Example:
AngularJS
Knockout
jQuery

opened

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

Type:

Boolean

Default Value: false

pageLoadingText

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

Type:

String

Default Value: 'Loading...'

pageLoadMode

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

Type:

String

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

When using the widget as an ASP.NET MVC Control, specify this option using the ListPageLoadMode enum. This enum accepts the following values: ScrollBottom and NextButton.

pagingEnabled

Deprecated

Use the paginate option instead.

Specifies whether or not the widget displays items by pages.

Type:

Boolean

Default Value: undefined

placeholder

The text displayed by the widget when nothing is selected.

Type:

String

Default Value: 'Select'

Show Example:
AngularJS
Knockout
jQuery

popupHeight

The height of the widget popup element.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The required height of the widget popup element.

Default Value: function() { return $(window).height() * 0.8 }
Default for android below version 4: 'auto'
Default for desktop: 'auto'
Default for iPad: 'auto'

Note that the option affects the actual popup size only if the fullScreen option is set to false. Otherwise, the popup is shown in a full screen mode.

Show Example:
AngularJS
Knockout
jQuery

popupWidth

The width of the widget popup element.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The required width of the widget popup element.

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

Note that the option affects the actual popup size only if the fullScreen option is set to false. Otherwise, the popup is shown in a full screen mode.

Show Example:
AngularJS
Knockout
jQuery

position

An object defining widget positioning options.

Default Value: undefined

pulledDownText

Specifies the text displayed in the pullDown panel when the widget 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 widget supports the "pull down to refresh" gesture.

Type:

Boolean

Default Value: false

If the option is set to true, the widget data is refreshed each time you pull down and release widget contents.

NOTE
The "pull down to refresh" gesture is not supported by desktop browsers and Windows Phone devices. You can use it only in mobile themes except the Windows Phone theme.

refreshingText

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

Type:

String

Default Value: 'Refreshing...'

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Boolean

Default Value: false

When this option is set to true, the widget 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
});

searchEnabled

Specifies whether the search box is visible.

Type:

Boolean

Default Value: true
Show Example:
AngularJS
Knockout
jQuery

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 option.

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 the binary operation used to filter data.

Type:

String

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

When using the widget as an ASP.NET MVC Control, specify this option using the DropDownSearchMode enum. 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'

Show Example:
AngularJS
Knockout
jQuery

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
NOTE
This option is read-only.

shading

A Boolean value specifying whether or not the main screen is inactive while the lookup is active.

Type:

Boolean

Default Value: true
NOTE
This option makes sense only if the usePopover option is set to false. Otherwise, shading is always disabled.

showCancelButton

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

Type:

Boolean

Default Value: true
Default for windows phone 8: false

The Cancel button cancels the attempt to change the lookup widget value.

Show Example:
AngularJS
Knockout
jQuery

showClearButton

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

Type:

Boolean

Default Value: false

The Clear button clears the currently chosen lookup value. The lookup window closes and the text specified by the placeholder option is shown in the lookup editor.

Show Example:
AngularJS
Knockout
jQuery

showDataBeforeSearch

Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value.

Type:

Boolean

Default Value: false

If this option is disabled, the widget 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.

showNextButton

Deprecated

Use the pageLoadMode option instead.

A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked.

Type:

Boolean

showPopupTitle

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

Type:

Boolean

Default Value: true

tabIndex

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

Type:

Number

Default Value: 0

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

text

The read-only option that holds the text displayed by the widget input element.

Type:

String

Read-only

title

The title of the lookup window.

Type:

String

Default Value: ''

Show Example:
AngularJS
Knockout
jQuery

titleTemplate

A template to be used for rendering the widget title.

Type:

template

Function parameters:
titleElement:

Element (jQuery or HTML)

The title's container.

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: 'title'

This option enables you to render the widget title depending on field values of the bound data model.

HTML
<div data-options="dxTemplate: { name:'myTitle' }">
    <h3><span data-bind="text: fullName"></span> info</h3>
</div>
NOTE
A binding context of a title template is the bound view model. So, you can bind template elements to the view model's fields directly (see the code above). To access another binding context within a title template, use the Knockout/AngularJS binding variables.

useNativeScrolling

Specifies whether or not the widget uses native scrolling.

Type:

Boolean

Default Value: true
Default for android below version 4: false

usePopover

Specifies whether or not to show lookup contents in a Popover widget.

Type:

Boolean

Default Value: false
Default for android below version 4: true
Default for desktop: true
Default for ios: true

The Lookup widget can display its contents in a Popover widget only if the fullScreen mode is disabled. Otherwise, lookup contents are displayed within the Popup widget.

Show Example:
AngularJS
Knockout
jQuery

validationError

Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option.

Type:

Object

Default Value: undefined

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: 'auto' | 'always'

The following option 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.

When using the widget as an ASP.NET MVC Control, specify this option using the ValidationMessageMode enum. This enum accepts the following values: Auto and Always.

value

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

Type: any
Default Value: null

Show Example:
AngularJS
Knockout
jQuery

valueChangeEvent

Specifies after which DOM events the widget updates search results.

Type:

String

Default Value: 'input change keyup'

valueExpr

Specifies which data field provides the widget's value. When this option is not set, the value is the entire data object.

Type:

String

|

function

Default Value: 'this'

Show Example:
AngularJS
Knockout
jQuery

visible

Specifies whether the widget is visible.

Type:

Boolean

Default Value: true

width

Specifies the widget's width.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget's width.

Default Value: undefined

This option accepts a value of one of the following types.

  • Number
    The width of the widget 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;
    }