Version: 2023.1
LanguageEnglish
  • C#

MultiColumnController

class in UnityEngine.UIElements

/

Implemented in:UnityEngine.UIElementsModule

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

Description

The default controller for a multi column view. Takes care of adding the MultiColumnCollectionHeader and reacting to the various callbacks.

Static Properties

cellLabelUssClassName The USS class name for default labels cells inside a multi column view.
cellUssClassName The USS class name for all cells inside a multi column view.
headerContainerUssClassName The USS class name for the header container inside a multi column view.
rowContainerUssClassName The USS class name for all row containers inside a multi column view.

Constructors

MultiColumnController Constructor. It will create the MultiColumnCollectionHeader to use for the view.

Public Methods

BindItem Binds a row of multiple cells to an item index.
DestroyItem Destroys a VisualElement when the view is rebuilt or cleared.
Dispose Unregisters events and removes the header from the hierarchy.
MakeItem Creates a VisualElement to use in the virtualization of the collection view. It will create a cell for every visible column.
PrepareView Initialization step once the view is set. It will insert the multi column header in the hierarchy and register to important callbacks.
UnbindItem Unbinds the row at the item index.

Events

columnSortingChanged Raised when sorting changes for a column.
headerContextMenuPopulateEvent Raised when a column is right-clicked to bring context menu options.