accessKey
The value of this option will be passed to the accesskey
attribute of the HTML element that underlies the widget.
allowItemReordering
Specifies whether a user can reorder list items. Grouped items cannot be moved from one group to another.
See Also
bounceEnabled
If the option is set to true, you can scroll the list content up (down) even if you have reached the bottom (top) boundary. But when you release the content, it returns to the bound position. If the option value is false, you can scroll the list content until you reach the boundary.
See Also
collapsibleGroups
This option makes sense if the grouped option is set to true.
If the collapsibleGroups option is set to true, the down arrow is displayed to the right of a group header. An end-user can collapse or expand a group simply clicking the group header.
See Also
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.
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.
elementAttr
Specifies the attributes to be attached to the widget's root element.
jQuery
$(function(){ $("#listContainer").dxList({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-list ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-list>
import { DxListModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxListModule ], // ... })
ASP.NET MVC Control
@(Html.DevExtreme().List() .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().List() _ .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
When this option is true, make sure that all data source objects have the following structure:
var dataSource = [{ key: "Group 1", // Group caption items: [ // Items in the group { ... }, { ... } ] }, { // ... }];
You can supply data to this structure using the DataSource object's group option.
See Also
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; }
indicateLoading
Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data.
itemDeleteMode
Use the ListItemDeleteMode
enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Static
, Toggle
, SlideButton
, SlideItem
, Swipe
, and Context
.
See Also
items
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.
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.
menuMode
Use the ListMenuMode
enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Context
and Slide
.
See Also
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. |
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. |
onGroupRendered
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. |
|
groupData |
The current group's data. |
|
groupElement |
The group's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
groupIndex |
The group's index. |
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 |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
jQueryEvent |
The jQuery event that caused the function's execution. Deprecated in favor of the event field. |
|
itemIndex | | |
The clicked item's index. In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }. |
itemElement |
The clicked item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The clicked item's data object. |
|
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. |
onItemContextMenu
Name | Type | Description |
---|---|---|
event | Event (jQuery or EventObject) |
The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
jQueryEvent |
The jQuery event that caused the function's execution. Deprecated in favor of the event field. |
|
itemIndex | | |
The target item's index. In a grouped list, the index is specified as an object defining group and item indexes: { group: 0, item: 0 }. |
itemElement |
The target item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The target item's data object. |
|
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. |
onItemDeleted
Name | Type | Description |
---|---|---|
itemIndex | | |
The removed item's index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }. |
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The removed item's data. |
|
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. |
Note that the itemDeleted event is raised only if an item is deleted using the appropriate method of the widget or end-user interaction. If you delete an item from an observable array passed to the dataSource or items option, the widget entirely reloads the items array without raising the itemDeleted and itemDeleting events.
See Also
onItemDeleting
Name | Type | Description |
---|---|---|
cancel | | |
Allows you to cancel the item deletion. |
itemIndex | | |
The item's index. In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }. |
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The data of the item to be removed. |
|
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. |
You can cancel item deletion by setting the handler parameter's cancel field to true. This field also accepts a Promise (jQuery or native), which enables you to perform an asynchronous action before an item is deleted.
var widgetOptions = { onItemDeleting: function(e) { var d = $.Deferred(); DevExpress.ui.dialog.confirm("Do you really want to delete the item?") .done(function(value) { d.resolve(!value); }) .fail(d.reject); e.cancel = d.promise(); } }
Note that the onItemDeleted and onItemDeleting handlers are not executed if an item is deleted from the data source without using the widget's UI or API.
onItemHold
A function that is executed when a collection item has been held for a specified period.
Name | Type | Description |
---|---|---|
jQueryEvent |
The jQuery event that caused the function's execution. Deprecated in favor of the event field. |
|
itemIndex | | |
The index of the item being held. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }. |
itemElement |
The container of the item being held. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The data object of the item being held. |
|
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. |
|
event | Event (jQuery or EventObject) |
The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
onItemRendered
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. |
|
itemData |
The current item's data. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemIndex |
The current item's index. |
onItemReordered
Name | Type | Description |
---|---|---|
toIndex |
The item's current index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }. |
|
fromIndex |
The item's previous index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }. |
|
itemIndex | | |
The item's index after reordering. This field holds the same value as toIndex. |
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The reordered item's data. |
|
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. |
onItemSwipe
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. |
itemData |
The swiped item's data. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemIndex | | |
The item's index. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }. |
direction |
The direction in which the item is swiped. |
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. 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. |
onSelectAllValueChanged
A function that is executed when the "Select All" check box value is changed. Applies only if the selectionMode is "all".
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 "Select All" check box's state. |
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 you use Knockout. |
|
addedItems | Array<any> |
The data of the items that have been selected. |
removedItems | Array<any> |
The data of the items whose selection has been canceled. |
pageLoadingText
Specifies the text shown in the pullDown panel, which is displayed when the list 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
.
See Also
pulledDownText
Specifies the text displayed in the pullDown panel when the list 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
If the option is set to true, list data is refreshed each time you pull down and release list contents.
See Also
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
searchEditorOptions
See the TextBox Configuration for options you can specify in this object.
searchEnabled
See Also
searchMode
Use the CollectionSearchMode
enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Contains
, StartsWith
, and Equals
.
selectAllMode
The selectAllMode specifies how records should be selected on clicking the "Select All" check box. The following modes are available:
"page"
Selects items on the currently rendered pages."allPages"
Selects items on all pages.
See Also
selectedItemKeys
Array<any>
The item keys can be specified using the keyExpr option or the key option within the underlying Store.
See Also
- key in ArrayStore | CustomStore | LocalStore | ODataStore
selectionMode
This option accepts the following values.
"none"
Selection is disabled."single"
A user can select only a single item."multiple"
A user can select several items."all"
The multiple mode with a check box that selects/unselects all items.
If paging is enabled, the select all check box selects only items that have been already loaded.NOTEThe check box that selects/unselects all items is displayed only if the showSelectionControls option is enabled. Otherwise, the "all" mode works as "multiple".
Use the ListSelectionMode
enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Single
, Multiple
, All
, and None
.
See Also
showScrollbar
Setting this option makes sense only when the useNativeScrolling option is set to false.
Use the ShowScrollbarMode
enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: OnScroll
, OnHover
, Always
, and Never
.
See Also
tabIndex
The value of this option will be passed to the tabindex
attribute of the HTML element that underlies the widget.
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.