Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Experimental: this API is experimental and might be changed or removed in the future.

VisualElement

class in UnityEngine.Experimental.UIElements

/

Inherits from:Experimental.UIElements.Focusable


Implements interfaces:IStyle, ITransform, IUIElementDataWatch, IVisualElementScheduler

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

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

VisualElement contains several features that are common to all controls in UIElements, such as layout, styling and event handling. Several other classes derive from it to implement custom rendering and define behaviour for controls.

Properties

childCount Number of child elements in this object's contentContainer
clippingOptionsShould this element clip painting to its boundaries.
contentContainer child elements are added to this element, usually this
dataWatchAccess to this element data watch interface.
enabledInHierarchyReturns true if the VisualElement is enabled in its own hierarchy.
enabledSelfReturns true if the VisualElement is enabled locally.
persistenceKeyUsed for view data persistence (ie. tree expanded states, scroll position, zoom level).
scheduleRetrieves this VisualElement's IVisualElementScheduler
shadow Access to this element physical hierarchy
styleReference to the style object of this element.
this[int] Access to this element physical hierarchy
userDataThis property can be used to associate application-specific user data with this VisualElement.

Public Methods

AddAdd an element to this element's contentContainer
AddStyleSheetPathAdds this stylesheet file to this element list of applied styles
AnyDirtyChecks if any of the ChangeTypes have been marked dirty.
BringToFrontBrings this element to the end of its parent children list. The element will be visually in front of any overlapping sibling elements.
ChildrenReturns the elements from its contentContainer
ClearRemove all child elements from this element's contentContainer
ContainsReturns true if the element is a direct child of this VisualElement
ElementAtRetrieves the child element at position
FindAncestorUserDataSearchs up the hierachy of this VisualElement and retrieves stored userData, if any is found.
FindCommonAncestorFinds the lowest commont ancestor between two VisualElements inside the VisualTree hierarchy
GetEnumeratorAllows to iterate into this elements children
GetFirstAncestorOfTypeWalks up the hierarchy, starting from this element's parent, and returns the first VisualElement of this type
GetFirstOfTypeWalks up the hierarchy, starting from this element, and returns the first VisualElement of this type
GetFullHierarchicalPersistenceKeyCombine this VisualElement's VisualElement.persistenceKey with those of its parents to create a more unique key for use with VisualElement.GetOrCreatePersistentData.
GetOrCreatePersistentDataTakes a reference to an existing persisted object and a key and returns the object either filled with the persisted state or as-is.
HasStyleSheetPathChecks if this stylesheet file is in this element list of applied styles
InsertInsert an element into this element's contentContainer
OnPersistentDataReadyCalled when the persistent data is accessible and/or when the data or persistence key have changed (VisualElement is properly parented).
OverwriteFromPersistedDataOverwrite object from the persistent data store.
PlaceBehindPlaces 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.
PlaceInFrontPlaces 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.
RemoveRemoves this child from the hierarchy
RemoveAtRemove the child element located at this position from this element's contentContainer
RemoveFromHierarchyRemoves this element from its parent hierarchy
RemoveStyleSheetPathRemoves this stylesheet file from this element list of applied styles
SavePersistentDataWrite persistence data to file.
SendToBackSends this element to the beginning of its parent children list. The element will be visually behind any overlapping sibling elements.
SetEnabledChanges the VisualElement enabled state. A disabled VisualElement does not receive most events.
SortReorders child elements from this VisualElement contentContainer.

Protected Methods

OnStyleResolvedCallback when the styles of an object have changed.

Inherited Members

Properties

canGrabFocusReturn true if the element can be focused.
focusControllerReturn the focus controller for this element.
focusIndexAn integer used to sort focusables in the focus ring. A negative value means that the element can not be focused.

Public Methods

HandleEventHandle an event, most often by executing the callbacks associated with the event.
HasBubbleHandlersReturn true if event handlers for the event propagation bubble up phase have been attached on this object.
HasCaptureHandlersReturn true if event handlers for the event propagation capture phase have been attached on this object.
RegisterCallbackAdd an event handler on the instance. If the handler has already been registered on the same phase (capture or bubbling), this will have no effect.
UnregisterCallbackRemove callback from the instance.
BlurTell the element to release the focus.
FocusAttempt to give the focus to this element.

Did you find this page useful? Please give it a rating: