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.

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'

applyValueMode

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

Type:

String

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

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.

Use the EditorApplyValueMode enum to specify this option when the widget is used as an ASP.NET MVC 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 widget 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

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)

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 the widget should display.

Default Value: null

This option accepts one of the following.

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

  • URL
    The URL of a JSON file or service that returns JSON data.

  • 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
Data field names should not contain the following characters: ., ,, :, [, and ]. Their presence may cause issues in the widget's operation.

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.

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 widget responds to user interaction.

Type:

Boolean

Default Value: false

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.

displayValue

Returns the value currently displayed by the widget.

Type:

String

Read-only
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.

elementAttr

Specifies the attributes to be attached to the widget's root 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
    ],
    // ...
})
ASP.NET MVC Control
Razor C#
Razor VB
@(Html.DevExtreme().Lookup()
    .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().Lookup() _
    .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" }
    })
)

fieldTemplate

Specifies a custom template for the input field.

Type:

template

Function parameters:
selectedItem:

Object

The selected item's data.

fieldElement:

Element (jQuery or HTML)

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

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: null

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Boolean

Default Value: true, false, true (desktop)

fullScreen

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

Type:

Boolean

Default Value: false, true (iPhone)

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.

View Demo

groupTemplate

Specifies a custom template for group captions.

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. It is an HTML Element or a jQuery Element when you use jQuery.

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: 'group'

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 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: {}
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
    ],
    // ...
})
ASP.NET MVC Control
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 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 items.

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. It is an HTML Element or a jQuery Element when you use jQuery.

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: '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 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'

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:
component:

Lookup

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

Object

The model data. Available only if Knockout is used.

Default Value: null

onContentReady

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Lookup

The widget's instance.

element:

Element (jQuery or HTML)

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

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 function that is executed before the widget is disposed of.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Lookup

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onInitialized

A function that is executed only once, after the widget is initialized.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Lookup

The widget's instance.

element:

Element (jQuery or HTML)

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

Default Value: null

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

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:
component:

Lookup

The widget's instance.

element:

Element (jQuery or HTML)

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

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

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

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:
component:

Lookup

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

Object

The model data. Available only if Knockout is used.

Default Value: null

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Lookup

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. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onPageLoading

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Lookup

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

Object

The 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 in mobile themes only.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Lookup

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

Object

The 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:
component:

Lookup

The widget's instance.

element:

Element (jQuery or HTML)

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

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

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:
component:

Lookup

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

Object

The model data. Available only if Knockout is used.

selectedItem:

Object

The selected item's data.

Default Value: null

onTitleRendered

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:
component:

Lookup

The widget's instance.

element:

Element (jQuery or HTML)

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

model:

Object

The model data. Available only if Knockout is used.

titleElement:

Element (jQuery or HTML)

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

Default Value: null
See Also

onValueChanged

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Lookup

The widget's instance.

element:

Element (jQuery or HTML)

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

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

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 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: 'nextButton' | 'scrollBottom'

Use the ListPageLoadMode enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: ScrollBottom and NextButton.

placeholder

The text displayed by the widget when nothing is selected.

Type:

String

Default Value: 'Select'

popupHeight

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)

In the Material theme, the default value is calculated so that the Lookup contains four items.

This option 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%", "auto", "inherit".

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

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

popupWidth

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)

In the Material theme, the default value equals the Lookup width plus paddings and borders.

This option 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;
    }

position

An object defining widget positioning options.

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

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. You can use it only in mobile themes.

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
});
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 option.
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 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 a comparison operation used to search widget items.

Type:

String

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

Use the DropDownSearchMode enum to specify this option when the widget is used as an ASP.NET MVC 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
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, false (Material)

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

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.

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.

showPopupTitle

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 widget'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 option when the widget is used as an ASP.NET MVC 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 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: ''

titleTemplate

Specifies a custom template for the title.

Type:

template

Function parameters:
titleElement:

Element (jQuery or HTML)

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

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: 'title'

useNativeScrolling

Specifies whether or not the widget uses native scrolling.

Type:

Boolean

Default Value: true, false (desktop), true (Mac)

usePopover

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

Type:

Boolean

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

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.

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

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.

Use the ValidationMessageMode enum to specify this option when the widget is used as an ASP.NET MVC Control. 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
Raised Events: valueChanged

valueChangeEvent

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

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'

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 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;
    }