Angular Lookup Properties
An object defining configuration options for the Lookup widget.
accessKey
Specifies the shortcut key that sets focus on the widget.
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.
This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.
applyValueMode
Specifies the way an end-user applies the selected value.
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
.
cleanSearchOnOpening
Specifies whether or not the widget cleans the search box when the popup window is displayed.
closeOnOutsideClick
Specifies whether to close the drop-down menu if a user clicks outside it.
true if the menu should be closed; otherwise 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
$(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
A data source used to fetch data the widget should display.
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.
.
, ,
, :
, [
, 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.
displayExpr
Specifies the name of the data source item field whose value is displayed by the widget.
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.
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.
dropDownButtonTemplate
Specifies a custom template for the drop-down button.
elementAttr
Specifies the attributes to be attached to the widget's root element.
You can configure this option in an ASP.NET MVC Control as follows:
@(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
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.
focusStateEnabled
Specifies whether the widget can be focused using keyboard navigation.
fullScreen
A Boolean value specifying whether or not to display the lookup in full-screen mode.
grouped
A Boolean value specifying whether or not to group widget items.
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
Specifies the widget's 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; }
hint
Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled
Specifies whether the widget changes its state when a user pauses on it.
inputAttr
Specifies the attributes to be passed on to the underlying HTML element.
You can configure this option in an ASP.NET MVC Control as follows:
@(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.
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
An array of items displayed by the widget.
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
The value to be assigned to the name
attribute of the underlying HTML element.
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.
noDataText
The text or HTML markup displayed by the widget if the item collection is empty.
onClosed
A handler for the closed event.
Information about the event.
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. |
Assign a function to perform a custom action after a drop-down editor has been hidden.
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.
Information about the event.
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 handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
Information about the event.
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
A handler for the initialized event. Executed only once, after the widget is initialized.
Information about the event.
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 handler because it is executed before they are ready. Use the onContentReady handler instead.
onItemClick
A handler for the itemClick event.
Information about the event.
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 }. |
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.
Information about the event.
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. |
Assign a function to perform a custom action when the drop-down editor is shown.
onOptionChanged
A handler for the optionChanged event. Executed after an option of the widget is changed.
Information about the event.
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
A handler for the pageLoading event.
Information about the event.
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. |
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.
Information about the event.
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. |
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.
Information about the event.
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. |
Assign a function to perform a custom action on each scroll gesture.
onSelectionChanged
A handler for the selectionChanged event.
Information about the event.
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. |
Assign a function to perform a custom action when the selection changes.
onTitleRendered
A handler for the titleRendered event.
Information about the event.
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. |
Assign a function to perform a custom action after a collection item title is rendered.
onValueChanged
A handler for the valueChanged event.
Information about the event.
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. |
|
value |
The widget's new value. |
|
previousValue |
The widget's previous value. |
|
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. |
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.
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.
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
Use the paginate property instead.
Specifies whether or not the widget displays items by pages.
placeholder
The text displayed by the widget when nothing is selected.
popupHeight
Specifies the popup element's height. Applies only if fullScreen is false.
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.
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; }
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.
pullRefreshEnabled
A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture.
If the option is set to true, the widget data is refreshed each time you pull down and release widget contents.
refreshingText
Specifies the text displayed in the pullDown panel while the widget is being refreshed.
rtlEnabled
Switches the widget to a right-to-left representation.
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
Specifies whether the search box is visible.
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
Specifies the binary operation used to filter data.
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.
searchTimeout
Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed.
selectedItem
Gets the currently selected item.
shading
A Boolean value specifying whether or not the main screen is inactive while the lookup is active.
showCancelButton
Specifies whether to display the Cancel button in the lookup window.
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.
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.
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
Use the pageLoadMode property 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.
showPopupTitle
A Boolean value specifying whether or not to display the title in the popup window.
tabIndex
Specifies the number of the element when the Tab key is used for navigating.
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.
useNativeScrolling
Specifies whether or not the widget uses native scrolling.
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.
See Also
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.
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.
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
Specifies the widget's 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.