class in UnityEngine.UIElements
/
Inherits from:UIElements.BaseListView
/
Implemented in:UnityEngine.UIElementsModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseA list view with multi column support. For more information, refer to MultiColumnListView.
columns | The collection of columns for the multi-column header. |
sortColumnDescriptions | The collection of sorted columns by default. |
sortedColumns | Contains information about which columns are currently being sorted. |
sortingMode | Indicates how to sort columns. To enable sorting, set it to ColumnSortingMode.Default or ColumnSortingMode.Custom. The Default mode uses the sorting algorithm provided by MultiColumnController, acting on indices. You can also implement your own sorting with the Custom mode, by responding to the columnSortingChanged event. |
viewController | The view controller for this view, cast as a MultiColumnListViewController. |
MultiColumnListView | Initializes a MultiColumnListView with an empty header. |
SetViewController | Assigns the view controller for this view and registers all events required for it to function properly. |
columnSortingChanged | If a column is clicked to change sorting, this event is raised to allow users to sort the list view items. For a default implementation, set sortingMode to ColumnSortingMode.Default. |
headerContextMenuPopulateEvent | If a column is right-clicked to show context menu options, this event is raised to allow users to change the available options. |
arraySizeFieldUssClassName | The USS class name for the size field of the ListView when show bound collection size is enabled |
arraySizeFieldWithFooterUssClassName | The USS class name for the size field of the ListView when the footer is enabled. |
arraySizeFieldWithHeaderUssClassName | The USS class name for the size field of the ListView when foldout header is enabled. |
emptyLabelUssClassName | The USS class name for label displayed when ListView is empty. |
foldoutHeaderUssClassName | The USS class name for the foldout header of the ListView. |
footerAddButtonName | The name of the add button element in the footer. |
footerRemoveButtonName | The name of the remove button element in the footer. |
footerUssClassName | The USS class name for the footer of the ListView. |
itemUssClassName | The USS class name of item elements in ListView elements. |
listViewWithFooterUssClassName | The USS class name for ListView when add/remove footer is enabled. |
listViewWithHeaderUssClassName | The USS class name for ListView when foldout header is enabled. |
overMaxMultiEditLimitClassName | The USS class name for label displayed when ListView is trying to edit too many items. |
reorderableItemContainerUssClassName | The USS class name for item container in reorderable animated ListView. |
reorderableItemHandleBarUssClassName | The USS class name for drag handle bar in reorderable animated ListView. |
reorderableItemHandleUssClassName | The USS class name for drag handle in reorderable animated ListView. |
reorderableItemUssClassName | The USS class name for item elements in reorderable animated ListView. |
reorderableUssClassName | The USS class name for reorderable animated ListView elements. |
scrollViewWithFooterUssClassName | The USS class name for scroll view when add/remove footer is enabled. |
ussClassName | The USS class name for ListView elements. |
borderUssClassName | The USS class name for BaseVerticalCollectionView elements with a border. |
dragHoverBarUssClassName | The USS class name of the drag hover bar. |
dragHoverMarkerUssClassName | The USS class name of the drag hover circular marker used to indicate depth. |
itemAlternativeBackgroundUssClassName | The USS class name for odd rows in the BaseVerticalCollectionView. |
itemDragHoverUssClassName | The USS class name applied to an item element on drag hover. |
itemSelectedVariantUssClassName | The USS class name of selected item elements in the BaseVerticalCollectionView. |
listScrollViewUssClassName | The USS class name of the scroll view in the BaseVerticalCollectionView. |
disabledUssClassName | USS class name of local disabled elements. |
allowAdd | This property allows the user to allow or block the addition of an item when clicking on the Add Button. It must return true or false. |
allowRemove | This property allows the user to allow or block the removal of an item when clicking on the Remove Button. It must return true or false. |
bindingSourceSelectionMode | This property controls whether every element in the list will get its data source setup automatically to the correct item in the collection's source. |
headerTitle | This property controls the text of the foldout header when using showFoldoutHeader. |
makeFooter | This callback allows the user to make their own footer for this control. |
makeHeader | This callback allows the user to make their own header for this control. |
makeNoneElement | This callback allows the user to set a Visual Element to replace the "List is empty" Label shown when the ListView is empty. |
onAdd | This callback allows the user to implement their own code to be executed when the Add Button is clicked. |
onRemove | This callback allows the user to implement their own code to be executed when the Remove Button is clicked. |
overridingAddButtonBehavior | This callback allows the user to implement a DropdownMenu when the Add Button is clicked. |
reorderMode | This property controls the drag and drop mode for the list view. |
showAddRemoveFooter | This property controls whether a footer will be added to the list view. |
showBoundCollectionSize | This property controls whether the list view displays the collection size (number of items). |
showFoldoutHeader | This property controls whether the list view displays a header, in the form of a foldout that can be expanded or collapsed. |
viewController | The view controller for this view, cast as a BaseListViewController. |
contentContainer | Returns the content container for the BaseVerticalCollectionView. Because the BaseVerticalCollectionView control automatically manages its content, this always returns null. |
fixedItemHeight | The height of a single item in the list, in pixels. |
horizontalScrollingEnabled | This property controls whether the collection view shows a horizontal scroll bar when its content does not fit in the visible area. |
itemsSource | The data source for collection items. |
reorderable | Gets or sets a value that indicates whether the user can drag list items to reorder them. |
selectedIds | Returns the persistent IDs of selected items in the data source, regardless of whether they are collapsed or not. Always returns an enumerable, even if no item is selected, or a single item is selected. |
selectedIndex | Returns or sets the selected item's index in the data source. If multiple items are selected, returns the first selected item's index. If multiple items are provided, sets them all as selected. |
selectedIndices | Returns the indices of selected items in the data source. Always returns an enumerable, even if no item is selected, or a single item is selected. |
selectedItem | Returns the selected item from the data source. If multiple items are selected, returns the first selected item. |
selectedItems | Returns the selected items from the data source. Always returns an enumerable, even if no item is selected, or a single item is selected. |
selectionType | Controls the selection type. |
showAlternatingRowBackgrounds | This property controls whether the background colors of collection view rows alternate. Takes a value from the AlternatingRowBackground enum. |
showBorder | Enable this property to display a border around the collection view. |
virtualizationMethod | The virtualization method to use for this collection when a scroll bar is visible. Takes a value from the CollectionVirtualizationMethod enum. |
binding | Binding object that will be updated. |
bindingPath | Path of the target property to be bound. |
canGrabFocus | Return true if the element can be focused. |
delegatesFocus | Whether the element should delegate the focus to its children. |
focusable | True if the element can be focused. |
focusController | Return the focus controller for this element. |
tabIndex | An integer used to sort focusables in the focus ring. Must be greater than or equal to zero. |
childCount | Number of child elements in this object's contentContainer. |
contentRect | The rectangle of the content area of the element, in the local space of the element. (Read Only) |
customStyle | The custom style properties accessor of a VisualElement (Read Only). |
dataSource | Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children. |
dataSourcePath | Path from the data source to the value. |
dataSourceType | The possible type of data source assignable to this VisualElement. This information is only used by the UI Builder as a hint to provide some completion to the data source path field when the effective data source cannot be specified at design time. |
disablePlayModeTint | Play-mode tint is applied by default unless this is set to true. It's applied hierarchically to this VisualElement and to all its children that exist on an editor panel. |
enabledInHierarchy | Returns true if the VisualElement is enabled in its own hierarchy. |
enabledSelf | Returns true if the VisualElement is enabled locally. |
experimental | Returns the UIElements experimental interfaces. |
generateVisualContent | Delegate function to generate the visual content of a visual element. |
hierarchy | Access to this element physical hierarchy |
languageDirection | Indicates the directionality of the element's text. The value will propagate to the element's children. |
layout | The position and size of the VisualElement relative to its parent, as computed by the layout system. (Read Only) |
localBound | Returns a Rect representing the Axis-aligned Bounding Box (AABB) after applying the transform, but before applying the layout translation. |
name | The name of this VisualElement. |
paddingRect | The rectangle of the padding area of the element, in the local space of the element. |
panel | The panel onto which this VisualElement is attached. |
parent | The parent of this VisualElement. |
pickingMode | Determines if this element can be pick during mouseEvents or IPanel.Pick queries. |
resolvedStyle | The final rendered style values of a visual element, as it's rendered in the current frame.(Read Only) |
scaledPixelsPerPoint | Return the resulting scaling from the panel that considers the screen DPI and the customizable scaling factor, but not the transform scale of the element and its ancestors. See Panel.scaledPixelsPerPoint. This should only be called on elements that are part of a panel. |
schedule | Retrieves this VisualElement's IVisualElementScheduler |
style | Sets the style values on a VisualElement. |
styleSheets | Returns a VisualElementStyleSheetSet that manipulates style sheets attached to this element. |
this[int] | Retrieves the child element at a specific index. |
tooltip | Text to display inside an information box after the user hovers the element for a small amount of time. This is only supported in the Editor UI. |
transform | Returns a transform object for this VisualElement. ITransform |
usageHints | A combination of hint values that specify high-level intended usage patterns for the VisualElement. This property can only be set when the VisualElement is not yet part of a Panel. Once part of a Panel, this property becomes effectively read-only, and attempts to change it will throw an exception. The specification of proper UsageHints drives the system to make better decisions on how to process or accelerate certain operations based on the anticipated usage pattern. Note that those hints do not affect behavioral or visual results, but only affect the overall performance of the panel and the elements within. It's advised to always consider specifying the proper UsageHints, but keep in mind that some UsageHints might be internally ignored under certain conditions (e.g. due to hardware limitations on the target platform). |
userData | This property can be used to associate application-specific user data with this VisualElement. |
viewDataKey | Used for view data persistence, such as tree expanded states, scroll position, or zoom level. |
visible | Indicates whether or not this element should be rendered. |
visualTreeAssetSource | Stores the asset reference, if the generated element is cloned from a VisualTreeAsset. |
worldBound | Returns a Rect representing the Axis-aligned Bounding Box (AABB) after applying the world transform. |
worldTransform | Returns a matrix that cumulates the following operations (in order): -Local Scaling -Local Rotation -Local Translation -Layout Translation -Parent worldTransform (recursive definition - consider identity when there is no parent) |
AddToSelection | Adds an item to the collection of selected items. |
ClearSelection | Deselects any selected items. |
GetRootElementForId | Gets the root element of the specified collection view item. |
GetRootElementForIndex | Gets the root element of the specified collection view item. |
Rebuild | Clears the collection view, recreates all visible visual elements, and rebinds all items. |
RefreshItem | Rebinds a single item if it is currently visible in the collection view. |
RefreshItems | Rebinds all items currently visible. |
RemoveFromSelection | Removes an item from the collection of selected items. |
ScrollTo | Scrolls to a specific VisualElement. |
ScrollToItem | Scrolls to a specific item index and makes it visible. |
ScrollToItemById | Scrolls to a specific item id and makes it visible. |
SetSelection | Sets the currently selected item. |
SetSelectionWithoutNotify | Sets a collection of selected items without triggering a selection change callback. |
HasBubbleUpHandlers | Return true if event handlers for the event propagation BubbleUp phase have been attached to this object. |
HasTrickleDownHandlers | Returns true if event handlers, for the event propagation TrickleDown phase, are attached to this object. |
RegisterCallback | Adds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect. |
RegisterCallbackOnce | Adds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect. The event handler is automatically unregistered after it has been invoked exactly once. |
UnregisterCallback | Remove callback from the instance. |
Blur | Tell the element to release the focus. |
Focus | Attempt to give the focus to this element. |
Add | Add an element to this element's contentContainer |
AddToClassList | Adds a class to the class list of the element in order to assign styles from USS. Note the class name is case-sensitive. |
BringToFront | Brings this element to the end of its parent children list. The element will be visually in front of any overlapping sibling elements. |
Children | Returns the elements from its contentContainer. |
ClassListContains | Searches for a class in the class list of this element. |
Clear | Remove all child elements from this element's contentContainer |
ClearBinding | Removes a binding from the element. |
ClearBindings | Removes all bindings from the element. |
ClearClassList | Removes all classes from the class list of this element. AddToClassList |
Contains | Checks if this element is an ancestor of the specified child element. |
ContainsPoint | Checks if the specified point intersects with this VisualElement's layout. |
ElementAt | Retrieves the child element at a specific index. |
EnableInClassList | Enables or disables the class with the given name. |
FindAncestorUserData | Searches up the hierarchy of this VisualElement and retrieves stored userData, if any is found. |
FindCommonAncestor | Finds the lowest common ancestor between two VisualElements inside the VisualTree hierarchy. |
GetBinding | Gets the binding instance for the provided targeted property. |
GetBindingInfos | Gets information on all the bindings of the current element. |
GetClasses | Retrieve the classes for this element. |
GetDataSourceContext | Queries the dataSource and dataSourcePath of a binding object. |
GetFirstAncestorOfType | Walks up the hierarchy, starting from this element's parent, and returns the first VisualElement of this type |
GetFirstOfType | Walks up the hierarchy, starting from this element, and returns the first VisualElement of this type |
GetHierarchicalDataSourceContext | Queries the dataSource and dataSourcePath inherited from the hierarchy. |
HasBinding | Allows to know if a target property has a binding associated to it. |
IndexOf | Retrieves the child index of the specified VisualElement. |
Insert | Insert an element into this element's contentContainer |
MarkDirtyRepaint | Triggers a repaint of the VisualElement on the next frame. This method is called internally when a change occurs that requires a repaint, such as when UIElements.BaseField_1.value is changed or the text in a Label. If you are implementing a custom control, you can call this method to trigger a repaint when a change occurs that requires a repaint such as when using generateVisualContent to render a mesh and the mesh data has now changed. |
PlaceBehind | Places this element right before the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually behind of its sibling. |
PlaceInFront | Places this element right after the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually in front of its sibling. |
Remove | Removes this child from the contentContainerhierarchy. |
RemoveAt | Remove the child element located at this position from this element's contentContainer |
RemoveFromClassList | Removes a class from the class list of the element. |
RemoveFromHierarchy | Removes this element from its parent hierarchy. |
SendEvent | Sends an event to the event handler. |
SendToBack | Sends this element to the beginning of its parent children list. The element will be visually behind any overlapping sibling elements. |
SetBinding | Assigns a binding between a target and a source. |
SetEnabled | Changes the VisualElement enabled state. A disabled VisualElement does not receive most events. |
Sort | Reorders child elements from this VisualElement contentContainer. |
ToggleInClassList | Toggles between adding and removing the given class name from the class list. |
TryGetBinding | Gets the binding instance for the provided targeted property. |
TryGetDataSourceContext | Queries the dataSource and dataSourcePath of a binding object. |
TryGetLastBindingToSourceResult | Returns the last BindingResult of a binding object from the UI to the data source. |
TryGetLastBindingToUIResult | Returns the last BindingResult of a binding object from the data source to the UI. |
CreateViewController | Creates the view controller for this view. Override this method in inheritors to change the controller type. |
HandleEventBubbleUp | Executes logic on this element during the BubbleUp phase, immediately before this element's BubbleUp callbacks. Calling StopPropagation will prevent further invocations of this method along the propagation path. |
HandleEventTrickleDown | Executes logic on this element during the TrickleDown phase, immediately after this element's TrickleDown callbacks. Calling StopPropagation will prevent further invocations of this method along the propagation path. |
NotifyPropertyChanged | Informs the data binding system that a property of a control has changed. |
itemsAdded | This event is called for every item added to the itemsSource. Includes the item index. |
itemsRemoved | This event is called for every item removed from the itemsSource. Includes the item index. |
canStartDrag | Called when a drag operation wants to start in this collection view. |
dragAndDropUpdate | Called when a drag operation updates in this collection view. |
handleDrop | Called when a drag operation is released in this collection view. |
itemIndexChanged | Called when an item is moved in the itemsSource. |
itemsChosen | Callback triggered when the user acts on a selection of one or more items, for example by double-clicking or pressing Enter. |
itemsSourceChanged | Raised when the data source of a vertical collection view is assigned a new reference or new type. |
onItemsChosen | Obsolete. Use BaseVerticalCollectionView.itemsChosen instead. |
onSelectedIndicesChange | Obsolete. Use BaseVerticalCollectionView.selectedIndicesChanged instead. |
onSelectionChange | Obsolete. Use BaseVerticalCollectionView.selectionChanged instead. |
selectedIndicesChanged | Callback triggered when the selection changes. |
selectionChanged | Callback triggered when the selection changes. |
setupDragAndDrop | Called when a drag operation starts in this collection view. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.