Scripting API

VisualElement

class in UnityEngine.UIElements · UnityEngine.UIElementsModule · inherits from Focusable

74 of 97 of Unity's membersUnity's documentation
In Tassix

The base of every UI Toolkit element: a node in a panel's tree with a name, classes, style sheets, an inline style, and the rect its flexbox layout gives it.

Constructors 1

Fields 1

static readonly string disabledUssClassName

Properties 28

int childCount { get; }
virtual VisualElement contentContainer { get; }
Rect contentRect { get; }

The content box, inside borders and padding, in the element's space.

object? dataSource { get; set; }

The object this element's bindings (and its children's) read, unless a binding has its own.

PropertyPath dataSourcePath { get; set; }
Type? dataSourceType { get; set; }
bool enabledInHierarchy { get; }
bool enabledSelf { get; }
Hierarchy hierarchy { get; }
Rect layout { get; }

The element's rect in its parent's space (border box), as last laid out.

Rect localBound { get; }

The layout rect as the element's transform places it in its parent.

string name { get; set; }
IPanel? panel { get; }
VisualElement? parent { get; }

The element it was added to: a container whose content container holds it (a scroll view), else its parent.

PickingMode pickingMode { get; set; }
IResolvedStyle resolvedStyle { get; }
IVisualElementScheduler schedule { get; }
IStyle style { get; }
VisualElementStyleSheetSet styleSheets { get; }
VisualElement this[int key] { get; }
string tooltip { get; set; }
ITransform transform { get; }
UsageHints usageHints { get; set; }
object? userData { get; set; }
string viewDataKey { get; set; }
bool visible { get; set; }

Whether it draws: the resolved visibility (setting it sets the inline style).

Rect worldBound { get; }
Matrix4x4 worldTransform { get; }

Methods 41

void Add(VisualElement child)
void AddToClassList(string className)
void BringToFront()
IEnumerable<VisualElement> Children()
bool ClassListContains(string cls)
void Clear()
void ClearBinding(BindingId bindingId)
void ClearBindings()
void ClearClassList()
bool Contains(VisualElement child)
virtual bool ContainsPoint(Vector2 localPoint)
VisualElement ElementAt(int index)
void EnableInClassList(string className, bool enable)
object? FindAncestorUserData()
VisualElement? FindCommonAncestor(VisualElement other)
Binding? GetBinding(BindingId bindingId)
IEnumerable<BindingInfo> GetBindingInfos()
void GetBindingInfos(List<BindingInfo> bindingInfos)
IEnumerable<string> GetClasses()
DataSourceContext GetDataSourceContext(BindingId bindingId)
T? GetFirstAncestorOfType<T>()
T? GetFirstOfType<T>()
DataSourceContext GetHierarchicalDataSourceContext()

The data source and path this element's bindings resolve against (from it and its ancestors).

bool HasBinding(BindingId bindingId)
int IndexOf(VisualElement element)
void Insert(int index, VisualElement element)
void MarkDirtyRepaint()
virtual bool Overlaps(Rect rectangle)
void PlaceBehind(VisualElement sibling)
void PlaceInFront(VisualElement sibling)
void Remove(VisualElement element)
void RemoveAt(int index)
void RemoveFromClassList(string className)
void RemoveFromHierarchy()
void SendToBack()
void SetBinding(BindingId bindingId, Binding binding)
void SetEnabled(bool value)
void Sort(Comparison<VisualElement> comp)
string ToString()
void ToggleInClassList(string className)
bool TryGetBinding(BindingId bindingId, out Binding binding)
bool TryGetDataSourceContext(BindingId bindingId, out DataSourceContext context)

Events 1

event EventHandler<BindablePropertyChangedEventArgs>? propertyChanged

Not in Tassix yet 23

DoMeasure Finalize IsMarkedForRepaint SetActivePseudoState SetCheckedPseudoState TryGetLastBindingToSourceResult TryGetLastBindingToUIResult customStyle disablePlayModeTint experimental generateVisualContent hasActivePseudoState hasCheckedPseudoState hasDisabledPseudoState hasEnabledPseudoState hasFocusPseudoState hasHoverPseudoState hasInactivePseudoState hasRootPseudoState languageDirection paddingRect scaledPixelsPerPoint visualTreeAssetSource