Version: 2018.4
LanguageEnglish
  • C#

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 UIElements module implements the UIElements retained mode UI framework.

Classes

AttachToPanelEventEvent sent after an element is added to an element that is a descendent of a panel.
BaseField<T0>Abstract base class for controls.
BaseSlider<T0>This is a base class for the Slider fields.
BindableElementElement that can be bound to a property.
BlurEventEvent sent immediately after an element has lost focus. This event trickles down, it does not bubble up, and it cannot be cancelled.
BoxStyled visual element to match the IMGUI Box Style.
ButtonA clickable button.
CallbackEventHandlerInterface for classes capable of having callbacks to handle events.
ChangeEvent<T0>Sends an event when a value in a field changes.
CommandEventBase<T0>Base class for command events.
ContextClickEventThe event sent when clicking the right mouse button.
ContextualMenuManagerUse this class to display a contextual menu.
ContextualMenuManipulatorManipulator that displays a contextual menu when the user clicks the right mouse button or presses the menu key on the keyboard.
ContextualMenuPopulateEventThe event sent when a contextual menu requires menu items.
DetachFromPanelEventEvent sent just before an element is detach from its parent, if the parent is the descendant of a panel.
DragAndDropEventBase<T0>Base class for drag and drop events.
DragEnterEventUse the DragEnterEvent class to manage events that occur when dragging enters an element or one of its descendants. The DragEnterEvent is cancellable, it does not trickle down, and it does not bubble up.
DragExitedEventThe event sent to a dragged element when the drag and drop process ends.
DragLeaveEventUse the DragLeaveEvent class to manage events sent when dragging leaves an element or one of its descendants. The DragLeaveEvent is cancellable, it does not trickle down, and it does not bubble up.
DragPerformEventThe event sent to an element when another element is dragged and dropped on the element.
DragUpdatedEventThe event sent when the element being dragged enters a possible drop target.
DropdownMenuA drop-down menu.
EventBaseThe base class for all UIElements events.
EventBase<T0>Generic base class for events, implementing event pooling and automatic registration to the event type system.
EventDispatcherDispatches events to a IPanel.
ExecuteCommandEventThe event sent when an element should execute a command.
FocusableBase class for objects that can get the focus.
FocusChangeDirectionBase class for defining in which direction the focus moves in a focus ring.
FocusControllerClass in charge of managing the focus inside a Panel.
FocusEventEvent sent immediately after an element has gained focus. This event trickles down, it does not bubble up, and it cannot be cancelled.
FocusEventBase<T0>Base class for focus related events.
FocusInEventEvent sent immediately before an element gains focus. This event trickles down and bubbles up. This event cannot be cancelled.
FocusOutEventEvent sent immediately before an element loses focus. This event trickles down and bubbles up. This event cannot be cancelled.
FoldoutCollapsable section of UI.
GeometryChangedEventEvent sent after layout calculations, when the position or the dimension of an element changes. This event cannot be cancelled, it does not trickle down, and it does not bubble up.
IBindingExtensionsExtensions methods to provide additional IBindable functionality.
ImageA VisualElement representing a source texture.
IMGUIContainerElement that draws IMGUI content.
IMGUIEventClass used to send a IMGUI event that has no equivalent UIElements event.
InputEventSends an event when text from a TextField changes.
KeyboardEventBase<T0>Base class for keyboard events.
KeyDownEventEvent sent when a key is pressed on the keyboard. This event trickles down and bubbles up. This event is cancellable.
KeyUpEventEvent sent when a key is released on the keyboard. This event trickles down and bubbles up. This event is cancellable.
LabelProvides an Element displaying text.
ListViewA vertically scrollable area that only creates visual elements for visible items while allowing the binding of many more items. As the user scrolls, visual elements are recycled and re-bound to new data items.
ManipulatorBase class for objects that define user interaction with a VisualElement. Most often manipulators hold state for complex interactions, for example interactions that require a mouse down, mouse move mouse up sequence.
MinMaxSliderA min/max slider containing a representation of a range.
MouseCaptureControllerClass that manages capturing mouse events.
MouseCaptureEventEvent sent after a handler starts capturing the mouse.
MouseCaptureEventBase<T0>Event sent when the handler capturing the mouse changes.
MouseCaptureOutEventEvent sent before a handler stops capturing the mouse.
MouseDownEventMouse down event.
MouseEnterEventEvent 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.
MouseEnterWindowEventEvent sent when the mouse pointer enters a window. The event is cancellable, it does not trickle down, and it does not bubble up.
MouseEventBase<T0>The base class for mouse events.
MouseLeaveEventEvent 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.
MouseLeaveWindowEventEvent sent when the mouse pointer exits a window. The event is cancellable, it does not trickle down, and it does not bubble up.
MouseMoveEventMouse move event.
MouseOutEventEvent sent when the mouse pointer exits an element. The event trickles down, it bubbles up, and it is cancellable.
MouseOverEventEvent sent when the mouse pointer enters an element. The event trickles down, it bubbles up, and it is cancellable.
MouseUpEventMouse up event.
PanelChangedEventBase<T0>Abstract base class for events notifying of a panel change.
PopupWindowStyled visual element that matches the EditorGUILayout.Popup IMGUI element.
RepeatButtonA button that executes an action repeatedly while it is pressed.
ScrollerA vertical or horizontal scrollbar.
ScrollerButtonFor internal use only. The button used by the Scroller.
ScrollViewDisplays its contents inside a scrollable frame.
SliderExperimental.UIElements.Slider is a controller allowing the selection of a value from a range (min, max, value).
SliderIntA slider containing Integer discrete values.
TemplateContainerTemplate Container.
TextElementAbstract base class for VisualElement containing text.
TextFieldA textfield is a rectangular area where the user can edit a string.
TextInputFieldBase<T0>Abstract base class used for all text-based fields.
ToggleThis is the Toggle field.
TooltipEventEvent sent to find the first element that displays a tooltip.
UQueryUQuery is a set of extension methods allowing you to select individual or collection of visualElements inside a complex hierarchy.
UQueryExtensionsUQuery is a set of extension methods allowing you to select individual or collection of visualElements inside a complex hierarchy.
UxmlAttributeDescriptionBase class for describing an XML attribute.
UxmlBoolAttributeDescriptionDescribes a XML bool attribute.
UxmlChildElementDescriptionDescribe an allowed child element for an element.
UxmlColorAttributeDescriptionDescribes a XML attribute representing a Color as a string.
UxmlDoubleAttributeDescriptionDescribes a XML double attribute.
UxmlEnumAttributeDescription<T0>Describes a XML attribute representing an enum as a string.
UxmlEnumerationRestricts the value of an attribute to be taken from a list of values.
UxmlFactory<T0,T1>Generic base class for UXML factories, which instantiate a VisualElement using the data read from a UXML file.
UxmlFactory<T0>UxmlFactory specialization for classes that derive from VisualElement and that shares its traits, VisualElementTraits.
UxmlFloatAttributeDescriptionDescribes a XML float attribute.
UxmlIntAttributeDescriptionDescribes a XML int attribute.
UxmlLongAttributeDescriptionDescribes a XML long attribute.
UxmlRootElementFactoryFactory for the root UXML element.
UxmlRootElementTraits UxmlTraits for the UXML root element.
UxmlStringAttributeDescriptionDescribes a XML string attribute.
UxmlTraitsDescribes a VisualElement derived class for the parsing of UXML files and the generation of UXML schema definition.
UxmlTypeRestrictionBase class to restricts the value of an attribute.
UxmlValueBoundsRestricts the value of an attribute to be within the specified bounds.
UxmlValueMatchesRestricts the value of an attribute to match a regular expression.
ValidateCommandEventThe event sent to probe which elements accepts a command.
VisualContainerObsolete. Use VisualElement instead.
VisualElementBase class for objects that are part of the UIElements visual tree.
VisualElementExtensionsVisualElementExtensions is a set of extension methods useful for VisualElement.
VisualElementFocusChangeDirectionDefine focus change directions for the VisualElementFocusRing.
VisualElementFocusRingImplementation of a linear focus ring. Elements are sorted according to their focusIndex.
VisualTreeAssetInstances of this class hold a tree of `VisualElementAsset`s. It is created from an UXML file, and each `VisualElementAsset` represents a UXML node inside this file. A `VisualTreeAsset` can be Cloned to yield a tree of `VisualElement`s.
WheelEventMouse wheel event.

Structs

CreationContextThis class is used during UXML template instantiation.
CursorStyleScript interface for VisualElement cursor style property IStyle.cursor.
FlexUse this structure to set the IStyle.Flex shorthand property which sets the IStyle.flexGrow, IStyle.flexShrink, and IStyle.flexBasis properties.
ManipulatorActivationFilterUsed by manipulators to match events against their requirements.
StyleValue<T0>This generic structure encodes a value type that can come from USS or be specified programmatically.

Enumerations

AlignThis enumeration contains values to control how an element is aligned in its parent during the layout phase.
ChangeTypeEnum which describes the various types of changes that can occur on a VisualElement.
FlexDirectionThis enumeration defines values used to control in which direction a container will place its children during layout.
JustifyThis enumeration contains values to control how children are justified during layout.
PositionTypeThis enumeration contains values to control how an element is positioned in its parent container.
PropagationPhaseThe propagation phases of an event.
SelectionTypeControls how many items can be selected at once.
SliderDirectionThis is the direction of the Slider and SliderInt.
TrickleDownUse this enum to specify during which phases the event handler is executed.
VisibilityThis enumeration contains values to specify whether or not an element is visible.
WrapThis enumeration contains values to control how elements are placed in a container if not enough space is available.