UI element control that displays a hierarchy.
| Property | Description |
|---|---|
| Filter | Get or set the filter used to display the hierarchy. |
| Filtering | Whether the hierarchy view is currently filtering nodes. |
| Flattened | The underlying Hierarchy.HierarchyFlattened of this HierarchyView. |
| Source | Gets the source hierarchy used to populate the hierarchy view. Use HierarchyView.SetSourceHierarchy to change it. |
| StyleContainer | Returns the UIElements.VisualElement used as the container for the styles and stylesheets of the HierarchyView. |
| UpdateNeeded | Whether the hierarchy view requires an update. |
| UpdateProgress | The current progress of the hierarchy view update. |
| Updating | Whether the hierarchy view is currently updating. |
| ViewModel | The underlying Hierarchy.HierarchyViewModel of this HierarchyView. |
| Constructor | Description |
|---|---|
| HierarchyView | Create a new instance of the HierarchyView. |
| Method | Description |
|---|---|
| Collapse | Collapse the specified node. |
| CollapseAll | Collapse all nodes in the hierarchy. |
| CollapseRecursive | Collapse the specified node and all its ancestors or descendants recursively. |
| Deselect | Clears the selection state of the specified node. |
| DeselectAll | Clears the current selection, making all nodes unselected. |
| DeselectRecursive | Clears the selection state of the specified node and all its ancestors or descendants recursively. |
| Dispose | Dispose the HierarchyView and all its resources. |
| Expand | Expands the specified node. |
| ExpandAll | Expands all nodes in the hierarchy. |
| ExpandRecursive | Expands the specified node and all its ancestors or descendants recursively. |
| Frame | Frame the specified node, expanding its ancestors and scrolling to it. |
| GetState | Get the current viewstate of the HierarchyView. |
| Hide | Hides the specified node. |
| HideAll | Hides all nodes in the hierarchy. |
| HideRecursive | Hides the specified node and all its ancestors or descendants recursively. |
| IsCollapsed | Determine if the specified node is collapsed. |
| IsExpanded | Determines if the specified node is expanded. |
| IsHidden | Determines if the specified node is hidden. |
| IsSelected | Determines if the specified node is selected. |
| IsSelectedOrAnyAncestorSelected | Determine if the specified node, or any of its ancestors, is selected. |
| IsShown | Determines if the specified node is shown. |
| Select | Selects the specified node. |
| SelectAll | Select all nodes in the hierarchy. |
| SelectRecursive | Selects the specified node and all ancestors or descendants recursively. |
| SetColumnDescriptors | Create a set of columns from a list of columns and cell descriptors. If a viewState is passed, all the columns default order, width and visibility will be overridden by the viewState. |
| SetColumns | Create Columns according to a list of columns specification and a potential ViewState. |
| SetSelection | Sets the current selection to a single node, making all other nodes unselected. |
| SetSourceHierarchy | Sets the source hierarchy used to populate the hierarchy view. |
| SetState | Update the HierarchyView with a new ViewState. |
| Show | Shows the specified node. |
| ShowAll | Shows all nodes in the hierarchy. |
| ShowRecursive | Shows the specified node and all its ancestors or descendants recursively. |
| ToggleSelected | Toggles the selection state of the specified node. |
| ToggleSelectedRecursive | Toggles the selection state of the specified node and all its ancestors or descendants recursively. |
| ToggleSelection | Toggles the selection state of the current selection. |
| Update | Update the hierarchy view displayed content. |
| UpdateIncremental | Incrementally update the hierarchy view displayed content. |
| UpdateIncrementalTimed | Incrementally update the hierarchy view displayed content until the time limit is reached. |
| Event | Description |
|---|---|
| BindViewItem | This event is fired when a HierarchyViewItem is bound to a hierarchy view, allowing customization of the view item. |
| FlagsChanged | Event that is invoked when flags on hierarchy nodes are changed. |
| GetTooltip | Customize the tooltip displayed when the mouse hovers the node name label. |
| PopulateContextMenu | This event is fired when a right click is handled on a node or on the background of the view. |
| SourceHierarchyChanged | This event is fired when the source hierarchy has been changed. |
| SourceHierarchyChanging | This event is fired when the source hierarchy is about to change. |
| UnbindViewItem | This event is fired when a HierarchyViewItem is unbound from a hierarchy view, allowing cleanup of the view item. Note that hierarchy view item are recycled by handler, so unbinding does not mean destruction. For this reason, it is preferable to not "undo" styles or modifications done during binding in this unbind event, for performance reasons. |
| Delegate | Description |
|---|---|
| GetTooltipEventHandler | Delegate type used to handle the event of getting a tooltip for a HierarchyViewItem. |
| PopulateContextMenuEventHandler | Delegate type used to handle HierarchyView.PopulateContextMenu event. |
| SourceHierarchyChangedEventHandler | Delegate type used to handle HierarchyView.SourceHierarchyChanged event. |
| SourceHierarchyChangingEventHandler | Delegate type used to handle HierarchyView.SourceHierarchyChanging event. |
| Property | Description |
|---|---|
| disabledUssClassName | USS class name of local disabled elements. |
| Property | Description |
|---|---|
| canGrabFocus | Whether the element can be focused. |
| delegatesFocus | Whether the element delegates the focus to its children. |
| focusable | Whether an element can potentially receive focus. |
| focusController | Returns the focus controller for this element. |
| tabIndex | An integer used to sort focusable elements in the focus ring. Must be greater than or equal to zero. |
| childCount | Number of child elements in this object's contentContainer. |
| contentContainer | Logical container where child elements are added. If a child is added to this element, the child is added to this element's content container instead. |
| 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 UIElements.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 UIElements.VisualElement and to all its children that exist on an editor panel. |
| enabledInHierarchy | Returns true if the UIElements.VisualElement is enabled in its own hierarchy. |
| enabledSelf | Returns true if the UIElements.VisualElement is enabled locally. |
| experimental | Returns the UIElements experimental interfaces. |
| generateVisualContent | Delegate function to generate the visual content of a visual element. |
| hasActivePseudoState | Returns true if this element matches the :active pseudo-class. |
| hasCheckedPseudoState | Returns true if this element matches the :checked pseudo-class. |
| hasDisabledPseudoState | Returns true if this element matches the :disabled pseudo-class. |
| hasEnabledPseudoState | Returns true if this element matches the :enabled pseudo-class. |
| hasFocusPseudoState | Returns true if this element matches the :focus pseudo-class. |
| hasHoverPseudoState | Returns true if this element matches the :hover pseudo-class. |
| hasInactivePseudoState | Returns true if this element matches the :inactive pseudo-class. |
| hasRootPseudoState | Returns true if this element matches the :root pseudo-class. |
| 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 the target of pointer events or picked by UIElements.IPanel.Pick queries. |
| resolvedStyle | The final rendered style values of a visual element, as it's rendered in the current frame.(Read Only) |
| resourcesReleased | Indicates if the element has released its reusable resources, in which case it can not be modified or added again. |
| 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 the IVisualElementScheduler associated to this VisualElement. Use it to enqueue actions. |
| style | Sets the style values on a UIElements.VisualElement. |
| styleSheets | Returns a UIElements.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. |
| usageHints | A combination of hint values that specify high-level intended usage patterns for the UIElements.VisualElement. This property can only be set when the UIElements.VisualElement is not yet part of a UIElements.Panel. Once part of a UIElements.Panel, this property becomes effectively read-only, and attempts to change it will throw an exception. The specification of proper UIElements.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 UIElements.UsageHints, but keep in mind that some UIElements.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) |
| Method | Description |
|---|---|
| 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. |
| RegisterCallbackOnce | Adds an event handler to the instance. 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 | Attempts to give the focus to this element. |
| Add | Adds an element to the contentContainer of this element. |
| 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 | Removed 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. UIElements.VisualElement.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 UIElements.VisualElement._dataSource and UIElements.VisualElement._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 UIElements.VisualElement._dataSource and UIElements.VisualElement._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 |
| IsMarkedForRepaint | Checks if the UIElements.VisualElement is marked dirty for repaint. |
| MarkDirtyRepaint | Marks that the UIElements.VisualElement requires a repaint. |
| 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. |
| ReleaseResources | Releases reusable resources associated with this element and makes the element unusable. |
| Remove | Removes this child from the UIElements.VisualElement._hierarchy of its UIElements.VisualElement._contentContainer. |
| RemoveAt | Removes a child, at the provided index, from the list of children of the current element. |
| 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. |
| SetActivePseudoState | Sets whether or not this element is displayed as being active. |
| SetBinding | Assigns a binding between a target and a source. |
| SetCheckedPseudoState | Sets whether or not this element is displayed as being checked. |
| SetEnabled | Changes the UIElements.VisualElement enabled state. A disabled visual element 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 UIElements.VisualElement._dataSource and UIElements.VisualElement._dataSourcePath of a binding object. |
| TryGetLastBindingToSourceResult | Returns the last UIElements.BindingResult of a binding object from the UI to the data source. |
| TryGetLastBindingToUIResult | Returns the last UIElements.BindingResult of a binding object from the data source to the UI. |
| Method | Description |
|---|---|
| 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. |