A Foldout control is a collapsible section of a user interface. When toggled, it expands or collapses, which hides or reveals the elements it contains.

Foldout.UxmlFactory

Instantiates a Foldout using the data from a UXML file.

Foldout.UxmlTraits

Defines Foldout.UxmlTraits for the Foldout.

GenericDropdownMenu

GenericDropdownMenu allows you to display contextual menus with default textual options or any VisualElement.

GeometryChangedEvent

This event is sent after layout calculations, when the position or the dimension of an element changes.

This is an enclosing container for a group of UnityEngine.UIElements.IGroupBoxOption. All group options within this container will interact together to allow a single selection, using the UnityEngine.UIElements.DefaultGroupManager. Default options are RadioButton, but users can provide other implementations. If no UnityEngine.UIElements.IGroupBox is found in the hierarchy, the default container will be the panel.

GroupBox.UxmlFactory

Instantiates a GroupBox using data from a UXML file.

GroupBox.UxmlTraits

Defines GroupBox.UxmlTraits for the GroupBox.

HelpBox

Makes a help box with a message to the user.

HelpBox.UxmlFactory

Instantiates a HelpBox with data from a UXML file.

HelpBox.UxmlTraits

Defines HelpBox.UxmlTraits for the HelpBox.

IBindingExtensions

Extensions methods to provide additional IBindable functionality.

Image

A VisualElement representing a source texture.

Image.UxmlFactory

Instantiates an Image using the data read from a UXML file.

Image.UxmlTraits

Defines Image.UxmlTraits for the Image.

IMGUIContainer

Element that draws IMGUI content.

IMGUIContainer.UxmlFactory

Instantiates an IMGUIContainer using the data read from a UXML file.

IMGUIContainer.UxmlTraits

Defines IMGUIContainer.UxmlTraits for the IMGUIContainer.

IMGUIEvent

Class used to send a IMGUI event that has no equivalent UIElements event.

ImmediateModeElement

VisualElement that can implement custom immediate mode rendering.

INotifyValueChangedExtensions

INotifyValueChangedExtensions is a set of extension methods useful for objects implementing INotifyValueChanged<T>.

InputEvent

Sends an event when text from a TextField changes.

InputWrapper

Interface to the Input system used by the BaseInputModule. With this it is possible to bypass the Input system with your own but still use the same InputModule. For example this can be used to feed fake input into the UI or interface with a different input system.

KeyboardEventBase<T>

This is the base class for keyboard events.

KeyboardNavigationManipulator

Provides a default implementation for translating input device specific events to higher level navigation operations as commonly possible with a keyboard.

KeyDownEvent

This event is sent when a key is pressed.

KeyUpEvent

This event is sent when a pressed key is released.

Label

Provides an Element displaying text.

Label.UxmlFactory

Instantiates a Label using the data read from a UXML file.

Label.UxmlTraits

Defines Label.UxmlTraits for the Label.

ListView

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

ListView.UxmlFactory

Instantiates a ListView using data from a UXML file.

ListView.UxmlTraits

Defines ListView.UxmlTraits for the ListView.

Manipulator

Base class for all Manipulator implementations.

MeshGenerationContext

Provides methods for generating a VisualElement's visual content during the callback.

MeshWriteData

A class that represents the vertex and index data allocated for drawing the content of a VisualElement.

MinMaxSlider

A min/max slider containing a representation of a range.

MinMaxSlider.UxmlFactory

Instantiates a MinMaxSlider using the data read from a UXML file.

MinMaxSlider.UxmlTraits

Defines MinMaxSlider.UxmlTraits for the MinMaxSlider.

MouseCaptureController

Class that manages capturing mouse events.

MouseCaptureEvent

Event sent after a handler starts capturing the mouse.

MouseCaptureEventBase<T>

Event sent when the handler capturing the mouse changes.

MouseCaptureOutEvent

Event sent before a handler stops capturing the mouse.

MouseDownEvent

Mouse down event.

MouseEnterEvent

Event sent when the mouse pointer enters an element or one of its descendent elements. The event is cancellable, it does not trickle down, and it does not bubble up.

MouseEnterWindowEvent

Event sent when the mouse pointer enters a window. The event is cancellable, it does not trickle down, and it does not bubble up.

MouseEventBase<T>

The base class for mouse events.

MouseLeaveEvent

Event sent when the mouse pointer exits an element and all its descendent elements. The event is cancellable, it does not trickle down, and it does not bubble up.

MouseLeaveWindowEvent

Event sent when the mouse pointer exits a window. The event is cancellable, it does not trickle down, and it does not bubble up.

MouseManipulator

MouseManipulators have a list of activation filters.

MouseMoveEvent

Mouse move event.

MouseOutEvent

Event sent when the mouse pointer exits an element. The event trickles down, it bubbles up, and it is cancellable.

MouseOverEvent

Event sent when the mouse pointer enters an element. The event trickles down, it bubbles up, and it is cancellable.

MouseUpEvent

Mouse up event.

NavigationCancelEvent

Event sent when the user presses the cancel button.

NavigationEventBase<T>

Navigation events abstract base class.

NavigationMoveEvent

Event typically sent when the user presses the D-pad, moves a joystick or presses the arrow keys.

NavigationSubmitEvent

Event sent when the user presses the submit button.

PanelChangedEventBase<T>

Abstract base class for events notifying of a panel change.

PanelSettings

Defines a Panel Settings asset that instantiates a panel at runtime. The panel makes it possible for Unity to display UXML-file based UI in the Game view.

PanelTextSettings

Represents text rendering settings for a specific UI panel. textSettings

PointerCancelEvent

This event is sent when pointer interaction is cancelled.

PointerCaptureEvent

Event sent when a pointer is captured by a VisualElement.

PointerCaptureEventBase<T>

Base class for pointer capture events and mouse capture events.

PointerCaptureHelper

A static class to capture and release pointers.

PointerCaptureOutEvent

Event sent when a VisualElement releases a pointer.

PointerDownEvent

This event is sent when a pointer is pressed.

PointerEnterEvent

This event is sent when a pointer enters a VisualElement or one of its descendants.

PointerEventBase<T>

This is the base class for pointer events.

PointerId

A static class that holds pointer ID values.

PointerLeaveEvent

This event is sent when a pointer exits an element and all of its descendants.

PointerManipulator

PointerManipulators have a list of activation filters.

PointerMoveEvent

This event is sent when a pointer changes state.

PointerOutEvent

This event is sent when a pointer exits an element.

PointerOverEvent

This event is sent when a pointer enters an element.

PointerStationaryEvent

This event is sent when a pointer does not change for a set amount of time, determined by the operating system.

PointerType

A static class that holds pointer type values.

PointerUpEvent

This event is sent when a pointer's last pressed button is released.

PopupWindow

Styled visual element that matches the EditorGUILayout.Popup IMGUI element.

PopupWindow.UxmlFactory

Instantiates a PopupWindow using the data read from a UXML file.

PopupWindow.UxmlTraits

Defines PopupWindow.UxmlTraits for the PopupWindow.

ProgressBar

A control that displays the progress between a lower and upper bound value.

ProgressBar.UxmlFactory

RadioButton

A control that allows users to select a single option inside a RadioButtonGroup

RadioButton.UxmlFactory

Instantiates a RadioButton using data from a UXML file.

RadioButton.UxmlTraits

Defines RadioButton.UxmlTraits for the RadioButton.

RadioButtonGroup

A control that allows single selection out of a logical group of RadioButton elements. Selecting one will deselect the others.

RadioButtonGroup.UxmlFactory

Instantiates a RadioButtonGroup using data from a UXML file.

RadioButtonGroup.UxmlTraits

Defines RadioButtonGroup.UxmlTraits for the RadioButtonGroup.

RepeatButton

A button that executes an action repeatedly while it is pressed.

RepeatButton.UxmlFactory

Instantiates a RepeatButton using the data read from a UXML file.

RepeatButton.UxmlTraits

Defines RepeatButton.UxmlTraits for the RepeatButton.

RuntimePanelUtils

A collection of static methods that provide simple World, Screen, and Panel coordinate transformations.

Scroller

A vertical or horizontal scrollbar.

Scroller.UxmlFactory

Instantiates a Scroller using the data read from a UXML file.

Scroller.UxmlTraits

Defines Scroller.UxmlTraits for the Scroller.

ScrollView

Displays its contents inside a scrollable frame.

ScrollView.UxmlFactory

Instantiates a ScrollView using the data read from a UXML file.

ScrollView.UxmlTraits

Defines ScrollView.UxmlTraits for the ScrollView.

Slider

A slider containing floating point values.

Slider.UxmlFactory

Instantiates a Slider using the data read from a UXML file.

Slider.UxmlTraits

Defines Slider.UxmlTraits for the Slider.

SliderInt

A slider containing Integer discrete values.

SliderInt.UxmlFactory

Instantiates a SliderInt using the data read from a UXML file.

SliderInt.UxmlTraits

Defines SliderInt.UxmlTraits for the SliderInt.

StyleSheet

Style sheets are applied to visual elements in order to control the layout and visual appearance of the user interface.

TemplateContainer

Represents the root VisualElement of UXML file.

TemplateContainer.UxmlFactory

Instantiates and clones a TemplateContainer using the data read from a UXML file.

TemplateContainer.UxmlTraits

Defines TemplateContainer.UxmlTraits for the TemplateContainer.

TextElement

Base class for a VisualElement that displays text.

TextElement.UxmlFactory

Instantiates a TextElement using the data read from a UXML file.

TextElement.UxmlTraits

Defines TextElement.UxmlTraits for the TextElement.

TextField

A textfield is a rectangular area where the user can edit a string.

TextField.UxmlFactory

Instantiates a TextField using the data read from a UXML file.

TextField.UxmlTraits

Defines TextField.UxmlTraits for the TextField.

TextInputBaseField<TValueType>

Abstract base class used for all text-based fields.

TextInputBaseField<TValueType>.TextInputBase

This is the input text base class visual representation.

TextInputBaseField<TValueType>.UxmlTraits

Defines TextInputBaseField<TValueType>.UxmlTraits for .

ThemeStyleSheet

Represents a style sheet that's assembled from other style sheets.

Toggle

A Toggle is a clickable element that represents a boolean value.

Toggle.UxmlFactory

Instantiates a Toggle using data from a UXML file.

Toggle.UxmlTraits

Defines Toggle.UxmlTraits for the Toggle.

TooltipEvent

Event sent to find the first VisualElement that displays a tooltip.

TwoPaneSplitView

A SplitView that contains two resizable panes. One pane is fixed-size while the other pane has flex-grow style set to 1 to take all remaining space. The border between he panes is draggable to resize both panes. Both horizontal and vertical modes are supported. Requires exactly two child elements to operate.

TwoPaneSplitView.UxmlFactory

Instantiates a TwoPaneSplitView using the data read from a UXML file.

TwoPaneSplitView.UxmlTraits

Defines TwoPaneSplitView.UxmlTraits for the TwoPaneSplitView.

TypedUxmlAttributeDescription<T>

Base class for all the uxml specific attributes.

UIDocument

Defines a Component that connects VisualElements to GameObjects. This makes it possible to render UI defined in UXML documents in the Game view.

UQuery

UQuery is a set of extension methods allowing you to select individual or collection of visualElements inside a complex hierarchy.

UQueryExtensions

UQuery is a set of extension methods allowing you to select individual or collection of visualElements inside a complex hierarchy.

UxmlAttributeDescription

Base class for describing an XML attribute.

UxmlAttributeOverridesFactory

Factory for the root AttributeOverrides element.

UxmlAttributeOverridesTraits

Defines UxmlTraits for the AttributeOverrides tag.

UxmlBoolAttributeDescription

Describes a XML bool attribute.

UxmlChildElementDescription

Describe an allowed child element for an element.

UxmlColorAttributeDescription

Describes a XML attribute representing a as a string.

UxmlDoubleAttributeDescription

Describes a XML double attribute.

UxmlEnumAttributeDescription<T>

Describes a XML attribute representing an enum as a string.

UxmlEnumeration

Restricts the value of an attribute to be taken from a list of values.

UxmlFactory<TCreatedType>

UxmlFactory specialization for classes that derive from VisualElement and that shares its traits, .

UxmlFactory<TCreatedType, TTraits>

Generic base class for UXML factories, which instantiate a VisualElement using the data read from a UXML file.

UxmlFloatAttributeDescription

Describes a XML float attribute.

UxmlHash128AttributeDescription

Describes a XML Hash128 attribute.

UxmlIntAttributeDescription

Describes a XML int attribute.

UxmlLongAttributeDescription

Describes a XML long attribute.

UxmlRootElementFactory

Factory for the root UXML element.

UxmlRootElementTraits

Defines UxmlTraits for the UXML root element.

UxmlStringAttributeDescription

Describes a XML string attribute.

UxmlStyleFactory

Factory for the root Style element.

UxmlStyleTraits

Defines UxmlTraits for the Style tag.

UxmlTemplateFactory

Factory for the root Template element.

UxmlTemplateTraits

Defines UxmlTraits for the Template tag.

UxmlTraits

Describes a VisualElement derived class for the parsing of UXML files and the generation of UXML schema definition.

UxmlTypeAttributeDescription<TBase>

Describes an XML System.Type attribute.

UxmlTypeRestriction

Base class to restricts the value of an attribute.

UxmlValueBounds

Restricts the value of an attribute to be within the specified bounds.

UxmlValueMatches

Restricts the value of an attribute to match a regular expression.

ValidateCommandEvent

The event sent to probe which elements accepts a command.

VectorImage

An asset that represents a vector image.

VisualElement

Base class for objects that are part of the UIElements visual tree.

VisualElement.UxmlFactory

Instantiates a VisualElement using the data read from a UXML file.

VisualElement.UxmlTraits

Defines VisualElement.UxmlTraits for the VisualElement.

VisualElementExtensions

VisualElementExtensions is a set of extension methods useful for VisualElement.

VisualElementFocusChangeDirection

Define focus change directions for the VisualElementFocusRing.

VisualElementFocusRing

Implementation of a linear focus ring. Elements are sorted according to their focusIndex.

VisualTreeAsset

An instance of this class holds a tree of VisualElementAssets, created from a UXML file. Each node in the file corresponds to a VisualElementAsset. You can clone a VisualTreeAsset to yield a tree of VisualElements.

WheelEvent

Mouse wheel event.

Structs

Background

Describes a VisualElement background.

CreationContext

This structure holds information used during UXML template instantiation.

Cursor

Script interface for VisualElement cursor style property cursor.

CustomStyleProperty<T>

Define a custom style property for an element to be retrieved with CustomStyleResolvedEvent.

EventDispatcherGate

Gates control when the dispatcher processes events.

FontDefinition

Describes a VisualElement font.

Length

Reprensents a distance value.

ManipulatorActivationFilter

Used by manipulators to match events against their requirements.

StyleBackground

Style value that can be either a Background or a StyleKeyword.

StyleColor

Style value that can be either a or a StyleKeyword.

StyleCursor

Style value that can be either a Cursor or a StyleKeyword.

StyleEnum<T>

Style value that can be either an enum or a StyleKeyword.

StyleFloat

Style value that can be either a float or a StyleKeyword.

StyleFont

Style value that can be either a or a StyleKeyword.

StyleFontDefinition

Style value that can be either a FontDefinition or a StyleKeyword.

StyleInt

Style value that can be either an integer or a StyleKeyword.

StyleLength

Style value that can be either a Length or a StyleKeyword.

StyleTextShadow

Style value that can be either a TextShadow or a StyleKeyword.

TextShadow

Script interface for VisualElement text-shadow style property textShadow.

TimerState

Contains timing information of scheduler events.

UQueryBuilder<T>

Utility Object that contructs a set of selection rules to be ran on a root visual element.

UQueryState<T>

Query object containing all the selection rules. The object can be saved and rerun later without re-allocating memory.

UQueryState<T>.Enumerator

Vertex

Represents a vertex of geometry for drawing content of VisualElement.

VisualElement.Hierarchy

Hierarchy is a struct allowing access to the hierarchy of visual elements

VisualElementStyleSheetSet

This structure manipulates the set of StyleSheet objects attached to the owner VisualElement.

Interfaces

IBindable

Interface for all bindable fields.

IBinding

Base interface for Binding objects.

IChangeEvent

Base interface for ChangeEvent.

ICommandEvent

Interface for Command events.

ICustomStyle

This interface exposes methods to read custom style properties applied from USS files to visual elements.

IEventHandler

Interface for class capable of handling events.

IExperimentalFeatures

Give access to UIElement experimental features.

IFocusEvent

Interface for focus events.

IFocusRing

Interface for classes implementing focus rings.

IKeyboardEvent

This interface describes the data used by keyboard events.

IManipulator

Interface for Manipulator objects.

IMixedValueSupport

An interface that allows value fields to visually represent a mixed value.

IMouseCaptureEvent

Interface for mouse capture events.

IMouseEvent

Interface for mouse events.

INavigationEvent

Interface for all navigation events.

INotifyValueChanged<T>

Interface for controls that hold a value and can notify when it is changed by user input.

IPanel

Interface for classes implementing UI panels.

IPanelChangedEvent

Interface for panel change events.

IPointerCaptureEvent

Interface for pointer capture events and mouse capture events.

IPointerEvent

This interface describes properties available to pointer events.

IResolvedStyle

Style values after layout pass.

IStyle

This interface provides access to a VisualElement inline style data.

ITransform

This interface provides access to a VisualElement transform data.

IUxmlAttributes

This type allows UXML attribute value retrieval during the VisualElement instantiation. An instance will be provided to the factory method - see .

IUxmlFactory

Interface for UXML factories. While it is not strictly required, concrete factories should derive from the generic class .

IVisualElementScheduledItem

Represents a scheduled task created with a VisualElement's schedule interface.

IVisualElementScheduler

A scheduler allows you to register actions to be executed at a later point.