- Nancy Davolio (Sales Representative)
- Andrew Fuller (Vice President, Sales)
- Janet Leverling (Sales Representative)
- Margaret Peacock (Sales Representative)
- Steven Buchanan (Sales Manager)
- Michael Suyama (Sales Representative)
- Robert King (Sales Representative)
- Laura Callahan (Inside Sales Coordinator)
- Anne Dodsworth (Sales Representative)
Selected item: Nancy Davolio (Sales Representative)
The List Box component allows users to select items from a list of predefined strings. The component can be bound to any IEnumerable data source. The list of selected items can be accessed and/or specified via the Values property. To track selection changes, use the SelectedItemsChanged event or the two-way synchronization as demonstrated in this module.
In this demo, the component allows users to select only one item at a time. Select an item to see the corresponding object's property values.
Id | Name | Surname |
---|---|---|
1 | Nancy | Davolio |
2 | Andrew | Fuller |
3 | Janet | Leverling |
4 | Margaret | Peacock |
5 | Steven | Buchanan |
6 | Michael | Suyama |
7 | Robert | King |
8 | Laura | Callahan |
9 | Anne | Dodsworth |
Selected item: Nancy Davolio (Sales Representative)
The List Box can display data across multiple columns. To create columns, use DxListEditorColumn objects that include the following options for column customization:
- Caption — Specifies the column caption.
- FieldName — Specifies the data source field that populates column items.
- Visible — Specifies the column visibility.
- VisibleIndex — Specifies the column display order.
- Width — Specifies the column width.
- Nancy Davolio (Sales Representative)
- Andrew Fuller (Vice President, Sales)
To enable multiple selection in the List Box, set the SelectionMode property to ListBoxSelectionMode.Multiple.
- If the ShowCheckboxes option is enabled, users can click individual items and corresponding checkboxes or hold Shift to select a range of items.
- If the ShowCheckboxes option is disabled, users can press Ctrl to select individual items or hold Shift to select a range of items.
- Nancy Davolio (Sales Representative)
- Andrew Fuller (Vice President, Sales)
- Janet Leverling (Sales Representative)
- Margaret Peacock (Sales Representative)
- Steven Buchanan (Sales Manager)
- Michael Suyama (Sales Representative)
- Robert King (Sales Representative)
- Laura Callahan (Inside Sales Coordinator)
- Anne Dodsworth (Sales Representative)
- 1
- 2
The List Box component provides access to item values. The value is assigned to the editor's value when a user selects an item from the list. To enable this access, set the ValueFieldName property to the name of the data source field that ships with values for the List Box items.
If the ValueFieldName property is not specified, the List Box component searches for a Value field in the data source and uses this field as a value field. Otherwise, values are not assigned to editor items.
To access values of the selected items, use the Values property. To track selection changes, use the ValuesChanged event or two-way synchronization as demonstrated in this module.
The ListRenderMode property specifies how the List Box renders the item list.
- Entire — The List Box renders the entire item list. Use this option for small item lists where scrolling should be instantly.
- Virtual — The List Box renders items only after they appear in the viewport. This approach improves performance when the list contains many items.
In this demo, the ListRenderMode property is set to ListRenderMode.Virtual.
-
Nancy Davolio (206) 555-9857
-
Andrew Fuller (206) 555-9482
-
Janet Leverling (206) 555-3412
-
Margaret Peacock (206) 555-8122
-
Steven Buchanan (71) 555-4848
-
Michael Suyama (71) 555-7773
-
Robert King (71) 555-5598
-
Laura Callahan (206) 555-1189
-
Anne Dodsworth (71) 555-4444
The ItemDisplayTemplate property allows you to customize the appearance of List Box items. The property accepts a ListBoxItemDisplayTemplateContext object as the context parameter. You can use the parameter's members to get information about items:
In this demo, the ItemDisplayTemplate property is used to display the ListBox's items in a card-like view. Each item shows an employee's first name, last name, photo, and phone number.
Product | Unit Price | Quantity | Discount | Total |
---|---|---|---|---|
|
|
|
|
|
Queso Cabrales |
$14.00 |
12 |
0.00% |
$168.00 |
Singaporean Hokkien Fried Mee |
$10.00 |
10 |
0.00% |
$100.00 |
Mozzarella di Giovanni |
$35.00 |
5 |
0.00% |
$175.00 |
Tofu |
$19.00 |
9 |
0.00% |
$171.00 |
Manjimup Dried Apples |
$42.00 |
40 |
0.00% |
$1,680.00 |
Jack's New England Clam Chowder |
$8.00 |
10 |
0.00% |
$80.00 |
Manjimup Dried Apples |
$42.00 |
35 |
15.00% |
$1,470.00 |
Louisiana Fiery Hot Pepper Sauce |
$17.00 |
15 |
15.00% |
$255.00 |
Gustaf's Knäckebröd |
$17.00 |
6 |
5.00% |
$102.00 |
Ravioli Angelo |
$16.00 |
15 |
5.00% |
$240.00 |
Louisiana Fiery Hot Pepper Sauce |
$17.00 |
20 |
0.00% |
$340.00 |
Sir Rodney's Marmalade |
$65.00 |
40 |
5.00% |
$2,600.00 |
Geitost |
$2.00 |
25 |
5.00% |
$50.00 |
Camembert Pierrot |
$27.00 |
40 |
0.00% |
$1,080.00 |
Gorgonzola Telino |
$10.00 |
20 |
0.00% |
$200.00 |
Chartreuse verte |
$14.00 |
42 |
0.00% |
$588.00 |
Maxilaku |
$16.00 |
40 |
0.00% |
$640.00 |
Guaraná Fantástica |
$4.00 |
15 |
15.00% |
$60.00 |
Pâté chinois |
$19.00 |
21 |
15.00% |
$399.00 |
Longlife Tofu |
$8.00 |
21 |
0.00% |
$168.00 |
|
|
|
|
|
- Singaporean Hokkien Fried Mee
- Mozzarella di Giovanni
- Tofu
The ColumnCellDisplayTemplate property allows you to specify custom content and change the appearance of cells in ListBox columns. The property accepts a ListBoxColumnCellDisplayTemplateContext object as the context parameter. You can use the parameter's members to get information about columns:
This demo customizes the appearance of different columns.
-
-
-
Loading, please wait...
The DevExpress Blazor ListBox displays an empty data area in the following cases:
- The Data property is unset.
- The specified data source does not contain items.
- You use the DataAsync property or the CustomData property to bind the List Box to a data source. The component sends the first request to a remote data source and waits for a response.
Define the EmptyDataAreaTemplate to customize content displayed in the empty data area. The template's context parameter includes the IsDataLoading property that allows you to determine whether the List Box data is still loading data.