class in UnityEditor.IMGUI.Controls
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.
CloseThe MultiColumnHeader is a general purpose class that e.g can be used with the TreeView to create multi-column tree views and list views.
It supports resizing of columns widths by dragging and provides useful callbacks for reacting to user input.
Note that columns can be hidden by the user using the context menu of the MultiColumnHeader.
Terminology used in the API: The parameter name columnIndex
is used for indices into the columns array in the MultiColumnHeaderState object. While the parameter name visibleColumnIndex
refers to the currently visible column index shown in the MultiColumnHeader.
allowDraggingColumnsToReorder | Use this property to control whether the user can drag and drop columns to re-order them. |
canSort | Use this property to control whether sorting is enabled for all the columns. |
currentColumnIndex | The index of the column that is currently being handled during an event. This property can be used for column specific handling when overriding AddColumnHeaderContextMenuItems |
height | Customizable height of the multi column header. |
sortedColumnIndex | The index of the column that is set to be the primary sorting column. This is the column that shows the sorting arrow above the header text. |
state | This is the state of the MultiColumnHeader. |
MultiColumnHeader | Constructor. |
GetCellRect | Calculates a cell rect for a column and row using the visibleColumnIndex and rowRect parameters. |
GetColumn | Returns the column data for a given column index. |
GetColumnRect | Returns the header column Rect for a given visible column index. |
GetVisibleColumnIndex | Convert from column index to visible column index. |
IsColumnVisible | Check if a column is currently visible in the MultiColumnHeader. |
IsSortedAscending | Check the sorting order state for a column. |
OnGUI | Render and handle input for the MultiColumnHeader at the given rect. |
Repaint | Requests the window which contains the MultiColumnHeader to repaint. |
ResizeToFit | Resizes the column widths of the columns that have auto-resize enabled to make all the columns fit to the width of the MultiColumnHeader render rect. |
SetSortDirection | Change sort direction for a given column. |
SetSorting | Sets the primary sorting column and its sorting order. |
SetSortingColumns | Sets multiple sorting columns and the associated sorting orders. |
AddColumnHeaderContextMenuItems | Override this method to extend the default context menu items shown when context clicking the header area. |
ColumnHeaderClicked | Override to customize the behavior when clicking a column header. |
ColumnHeaderGUI | Override to customize the GUI of a single column header. |
OnSortingChanged | Called when sorting changes and dispatches the sortingChanged event. |
OnVisibleColumnsChanged | Called when the number of visible column changes and dispatches the visibleColumnsChanged event. |
SortingButton | Provides the button logic for a column header and the rendering of the sorting arrow (if visible). |
ToggleVisibility | Method for toggling the visibility of a column. |
columnSettingsChanged | Event raised when any settings from a column has changed (for example, a column width was resized). |
columnsSwapped | Event raised when the user switches the order of two columns. |
sortingChanged | Subscribe to this event to get notified when sorting has changed. |
visibleColumnsChanged | Subscribe to this event to get notified when the number of visible columns has changed. |
HeaderCallback | Delegate used for events from the MultiColumnHeader. |
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.