Configuration

An object defining configuration options for the Lookup widget.

accessKey

Specifies a shortcut key that sets focus on the widget element.

Type: String
Default Value: null

The accessKey option value is passed to the accesskey attribute of the actual HTML element of the widget.

activeStateEnabled

A Boolean value specifying 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

An object that defines widget animation options.

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.

NOTE: When configuring the widget using ASP.NET MVC Wrappers, 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.

JavaScript
var lookupOptions = {
    // ...
    closeOnOutsideClick: function(e) {
        return e.target === $("#someElement").get()[0];
    }
}

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

A Boolean value specifying whether or not the widget can respond to user interaction.

Type: Boolean
Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

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

elementAttr

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

Type: Object
Default Value: {}

When you configure this option using a server-side wrapper, pass a dictionary as shown in the following code.

@(Html.DevExtreme()
    // other widget options
    // ...
    .ElementAttr(new Dictionary<string, object>() {
        { "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 data that is bound to the selected item.
fieldElement: Object
An HTML element of the field to be rendered.
Return Value: String|DOM Node|jQuery
A template name or a template 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.

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

View Demo

See Also

focusStateEnabled

Specifies whether or not the widget can be focused.

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.

groupTemplate

The name of the template used to display a group header.

Type: template
Function parameters:
itemData: Object
The group object to be rendered.
itemIndex: Number
The index of the group to be rendered.
itemElement: jQuery
An HTML element of the group to be rendered.
Return Value: String|DOM Node|jQuery
A template name or a template container.
Default Value: 'group'

NOTE: A binding context of a group template is the data source object that corresponds to the currently rendered group. So, you can bind template elements to the group object fields directly. To access another binding context within a group template, use the Knockout/AngularJS binding variables.

height

Specifies the height of the widget.

Type: Number|String| function
Return Value: Number|String
The widget height.
Default Value: undefined

The option can hold a value of the following types.

  • number
    The height of the widget in pixels

  • string
    A CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit")

  • function
    A function returning the widget height, e.g.,

    JavaScript
    height: function () {
        return baseHeight - 10 + "%";
    }

hint

Specifies the text of the hint displayed for the widget.

Type: String
Default Value: undefined

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

Type: Boolean
Default Value: true

inputAttr

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

Type: Object
Default Value: {}

When you configure this option using a server-side wrapper, pass a dictionary as shown in the following code.

@(Html.DevExtreme()
    // other widget options
    // ...
    .InputAttr(new Dictionary<string, object>() {
        { "id", "inputId" },
        // ...
    })
)

isValid

Specifies whether the editor's value is valid.

Type: Boolean
Default Value: true

In Knockout approach, you may need to use an editor to inform end users that an error occurred during the validation of a ViewModel field. In this instance, set the editor's isValid option to the isValid property value of the dxValidator that validated the ViewModel's field. In addition, set the editor's validationError option to the validationError property value of the dxValidator object.

In the code below, the login specified by an end user is validated on the level of the ViewModel. If validation of the login value fails, a validation message is displayed on the Login editor.

HTML
<div data-bind="dxTextBox: {
    value: login,
    isValid: login.dxValidator.isValid,
    validationError: login.dxValidator.validationError,
    placeholder: 'Login'
}"></div>
JavaScript
var viewModel = {
    login: ko.observable("").extend({
        dxValidator: {
            validationRules: [{
                type: 'required',
                message: 'Login is required'
            }]
        }
    }),
    //...
}

NOTE: The editor's isValid option, as well as the validationError option, 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

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.

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.

itemTemplate

The template to be used for rendering items.

Type: template
Function parameters:
itemData: Object
The item object to be rendered.
itemIndex: Number
The index of the item to be rendered.
itemElement: jQuery
An HTML element of the item to be rendered.
Return Value: String|DOM Node|jQuery
A template name or a template container.
Default Value: 'item'

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

In Knockout approach, you can bind template elements to the item object's fields directly. To access another binding context within an item template, use Knockout binding variables.

In AngularJS approach, if you need to access item object fields within a template, use a variable whose name is assigned to the dx-item-alias directive. 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 an item template, use AngularJS binding variables.

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.

Type: Number
Default Value: 0

This option makes sense only if the searchEnabled option is set to true.

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 using DevExtreme ASP.NET MVC Wrappers, 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
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
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.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
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.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

Assign a function to perform a custom action when the widget is being removed.

NOTE: The function assigned to this option is executed only if the widget is removed using the remove(), empty(), or html() jQuery methods.

onInitialized

A handler for the initialized event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
Default Value: null

Assign a function to perform a custom action when the widget is initialized.

onItemClick

A handler for the itemClick event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
itemData: Object
The data that is bound to the clicked item.
itemElement: Object
An HTML element of the item.
itemIndex: Number|Object
The index of the clicked item. 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
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
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.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
name: String
Specifies the name of the option whose value is changed.
fullName: String
Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.
value: any
Specifies a new value for the option.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

onPageLoading

A handler for the pageLoading event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
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
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
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
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused the action execution.
scrollOffset: Object
Specifies 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
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
selectedItem: Object
Provides access to the currently selected item.
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
Provides function parameters.
Object structure:
titleElement: jQuery
The HTML element of the item title.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
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
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout approach.
value: Object
Specifies the widget's new value.
previousValue: Object
Specifies the widget's previous value.
jQueryEvent: jQuery.Event
A deprecated field. Use the itemData field instead.
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'

NOTE: When configuring the widget using ASP.NET MVC Wrappers, specify this option using the ListPageLoadMode enum. This enum accepts the following values: ScrollBottom and NextButton.

pagingEnabled

Deprecated

Use the dataSource.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

Specifies whether or not the current component supports a right-to-left representation.

Type: Boolean
Default Value: false

If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.

searchEnabled

A Boolean value specifying whether or not the search bar is visible.

Type: Boolean
Default Value: true

To specify a field by which to search items, assign the required field name to the searchExpr configuration option of the DataSource object passed to the dataSource option of the widget.

JavaScript
var dataSource = new DevExpress.data.DataSource({
    store: myStore,
    searchExpr: "firstName"
});

If you need to search items by several field values, assign an array of field names to the searchExpr option of the DataSource.

JavaScript
var dataSource = new DevExpress.data.DataSource({
    store: myStore,
    searchExpr: ["firstName", "lastName"]
});

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

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
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'

NOTE: When configuring the widget using ASP.NET MVC Wrappers, 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: Object
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
Default Value: undefined

showPopupTitle

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

Type: Boolean
Default Value: true

tabIndex

Specifies the widget tab index.

Type: Number
Default Value: 0

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: jQuery
An HTML element containing the rendered title.
Return Value: String|DOM Node|jQuery
A template name or a template 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

Holds the object that defines the error that occurred during validation.

Type: Object
Default Value: undefined

In Knockout approach, you may need to use an editor to inform end users that an error occurred during the validation of a ViewModel field. In this instance, set the editor's isValid option to the isValid property value of the dxValidator that validated the ViewModel's field. In addition, set the editor's validationError option to the validationError property value of the dxValidator object.

In the code, the login specified by an end user is validated on the level of the ViewModel. If validation of the login value fails, a validation message is displayed on the Login editor.

HTML
<div data-bind="dxTextBox: {
    value: login,
    isValid: login.dxValidator.isValid,
    validationError: login.dxValidator.validationError,
    placeholder: 'Login'
}"></div>
JavaScript
var viewModel = {
    login: ko.observable("").extend({
        dxValidator: {
            validationRules: [{ type: 'required', message: 'Login is required' }]
        }
    }),
    //...
}

The editor's validationError option, as well as the isValid option, 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

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.

NOTE: When configuring the widget using ASP.NET MVC Wrappers, specify this option using the ValidationMessageMode enum. This enum accepts the following values: Auto and Always.

value

The currently selected value in the widget.

Type: Object
Default Value: null

This option returns a value of the specified field of the currently selected item object. The field whose value is returned by the value option is specified via the valueExpr option.

Show Example:
AngularJS
Knockout
jQuery

valueChangeEvent

Specifies DOM event names that update a widget's value.

Type: String
Default Value: 'input change keyup'

The option takes on a string value representing a DOM event name or several DOM event names separated by a space. You can assign any DOM event name to this option. For example, "change", "blur", "input", "keyup", etc.

valueExpr

Specifies the name of a data source item field whose value is held in the value configuration option.

Type: String|function
Default Value: null

Assign "this" to this option in order for the widget to return the entire selected object from the value option. Note that the "this" value is not supported by a widget bound to an ODataStore.

If you leave the option unassigned, the value option holds the entire dataSource item corresponding to the selected value.

Show Example:
AngularJS
Knockout
jQuery

visible

A Boolean value specifying whether or not the widget is visible.

Type: Boolean
Default Value: true

width

Specifies the width of the widget.

Type: Number|String| function
Return Value: Number|String
The widget width.
Default Value: undefined

The option can hold a value of the following types.

  • numeric
    The widget width in pixels.
  • string
    A CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit").
  • function
    The function returning the widget width. For example, see the following code.

    JavaScript
    width: function () { 
        return baseWidth - 10 + "%";
    }