accessKey
The value of this option will be passed to the accesskey
attribute of the HTML element that underlies the widget.
applyValueMode
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
.
closeOnOutsideClick
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
$(function () { $("#lookupContainer").dxLookup({ // ... closeOnOutsideClick: function(e) { return e.target === $("#someElement").get()[0]; } }); });
Angular
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
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.
.
, ,
, :
, [
, 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.
elementAttr
Specifies the attributes to be attached to the widget's root element.
jQuery
$(function(){ $("#lookupContainer").dxLookup({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<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
@(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" } }) )
grouped
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.
height
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:JavaScriptheight: function() { return window.innerHeight / 1.5; }
inputAttr
jQuery
$(function(){ $("#lookupContainer").dxLookup({ // ... inputAttr: { id: "inputId" } }); });
Angular
<dx-lookup ... [inputAttr]="{ id: 'inputId' }"> </dx-lookup>
import { DxLookupModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxLookupModule ], // ... })
ASP.NET MVC Control
@(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
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.
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
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.
minSearchLength
The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true.
name
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.
onClosed
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
onContentReady
A function that is executed when the widget's content is ready and each time the content is changed.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only when using Knockout. |
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.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
onInitialized
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
You cannot access widget elements in this function because it is executed before they are ready. Use the onContentReady function instead.
onItemClick
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
itemData |
The clicked item's data. |
|
itemElement |
The item's container. |
|
itemIndex | | |
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 EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
onOpened
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
onOptionChanged
Name | Type | Description |
---|---|---|
name |
The option's short name. |
|
model |
The model data. Available only if you use Knockout. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The widget's instance. |
|
fullName |
The option's full name. |
|
value | any |
The option's new value. |
onPageLoading
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
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.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
onScroll
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
scrollOffset |
The current scroll offset in the following format { top: topOffset, left: leftOffset }. |
|
reachedLeft |
Indicates whether the container's left boundary is reached. |
|
reachedRight |
Indicates whether the container's right boundary is reached. |
|
reachedTop |
Indicates whether the container's top boundary is reached. |
|
reachedBottom |
Indicates whether the container's bottom boundary is reached. |
onSelectionChanged
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
selectedItem |
The selected item's data. |
onTitleRendered
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
titleElement |
The title's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onValueChanged
A function that is executed after the widget's value is changed.
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
previousValue |
The widget's previous value. |
|
value |
The widget's new value. |
|
model |
The model data. Available only if Knockout is used. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The widget's instance. |
pageLoadingText
Specifies the text shown in the pullDown panel, which is displayed when the widget is scrolled to the bottom.
pageLoadMode
Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked.
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
.
popupHeight
Specifies the popup element's height. Applies only if fullScreen is false.
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:JavaScriptheight: function() { return window.innerHeight / 1.5; }
popupWidth
Specifies the popup element's width. Applies only if fullScreen is false.
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:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
position
An object defining widget positioning options.
pulledDownText
Specifies the text displayed in the pullDown panel when the widget is pulled below the refresh threshold.
pullingDownText
Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold.
rtlEnabled
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.
DevExpress.config({ rtlEnabled: true });
See Also
- Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors
searchEnabled
See Also
searchExpr
Specifies the name of a data source item field or an expression whose value is compared to the search criterion.
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.
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
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
.
searchTimeout
Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed.
shading
showClearButton
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.
tabIndex
The value of this option will be passed to the tabindex
attribute of the HTML element that underlies the widget.
usePopover
Specifies whether or not to show lookup contents in a Popover widget.
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.
validationMessageMode
Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
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.
valueChangeEvent
Specifies the DOM events after which the widget's search results should be updated.
valueExpr
Specifies which data field provides the widget's value. When this option is not set, the value is the entire data object.
width
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:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
If you have technical questions, please create a support ticket in the DevExpress Support Center.