UXML element ListView

A ListView is a vertically scrollable area that links to and displays a list of items.

Note: The horizontal and vertical Scroller elements are standard UI Toolkit Scrollers.

Create a ListView

You can create a ListView with UI Builder, UXML, and C#.

To create a ListView with C#, create a new instance of a ListView object. For example:

ListView myElement = new ListView();

Bind a ListView

If you want to create a ListView with complex data and bind the ListView to visual elements, do the following:

• Use makeItem and bindItem to bind the ListView to data, register the appropriate callbacks, and modify the linked data source as needed.
• Use unbindItem to recycle an element for the ListView and unbind the data.
• Use destroyItem to clear the registered callbacks.

ListView versus ScrollView

You can use a ScrollView control to create the same functionalities as using a ListView. However, a ListView is more efficient than a ScrollView when you do the following:

• Populate list items
• Manage item height
• Bind and unbind to objects
• Instantiate the number of visual elements required to fill a page
• Recycle visual elements to optimize memory handling

Set item height

To change how item height is used to drive content, use the VirtualizationMethod:

• VirtualizationMethod.FixedHeight sets all items to the same height.
• VirtualizationMethod.DynamicHeight allows items to have varying heights.

Control the scroll speed

The ListView has a built-in child ScrollView element that allows you to scroll through the list. You can control the speed of the scroll by overriding the mouseWheelScrollSize, horizontalPageSize, and verticalPageSize properties of the ScrollView with C#.

Implement drag-and-drop operations for ListView

Drag-and-drop is a common feature in UI design. To implement the drag-and-drop operations, override the following methods:

• To enable dragging items, override canStartDrag.
• To set which items are dragged, override setupDragAndDrop.
• To get item status changes, override dragAndDropUpdate. You can perform certain actions based on the drag position or other conditions.
• To control the drag-and-drop behavior, override handleDrop.

During the drag-and-drop operation, you can enable the reordering of items by dragging. To enable, set the reorderable attribute to true in UI Builder, UXML, and C#.

Refer to Create a drag-and-drop list and tree views between windows for an example.

例

​ The best way to learn how to use ListView is to try examples:

• To see a simple ListView example, in Unity, select Window > UI Toolkit > Samples > List View.
• Create list and tree views: Use ListView, TreeView, MultiColumnListView, and MultiColumnTreeView to create list and tree views.
• Create a complex list view: Use ListView to create a custom Editor window with a list of characters.
• Bind to a list with ListView: Create a list of toggles and bind the list to an underlying list of GameSwitch objects.
• Create a drag-and-drop list and tree views between windows: Use ListView, TreeView, and MultiColumnListView to create a drag-and-drop UI between windows.

C# base class and namespace

C# class: ListView
Namespace: UnityEngine.UIElements
Base class: BaseListView

Inherited UXML attributes

This element inherits the following attributes from its base class:

This element also inherits the following attributes from VisualElement:

USS classes

The following table lists all the C# public property names and their related USS selector.

You can also use the Matching Selectors section in the Inspector or the UI Toolkit Debugger to see which USS selectors affect the components of the VisualElement at every level of its hierarchy.

その他の参考資料

• MultiColumnListView
• MultiColumnTreeView
• ScrollView
• TreeView