class in UnityEngine.Experimental.UIElements
/
Inherits from:Experimental.UIElements.Focusable
Implements interfaces:IStyle, ITransform, IUIElementDataWatch, IVisualElementScheduler
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.
| childCount | Number of child elements in this object's contentContainer |
| clippingOptions | Should this element clip painting to its boundaries. |
| contentContainer | child elements are added to this element, usually this |
| dataWatch | Access to this element data watch interface. |
| enabledInHierarchy | Returns true if the VisualElement is enabled in its own hierarchy. |
| enabledSelf | Returns true if the VisualElement is enabled locally. |
| persistenceKey | Used for view data persistence (ie. tree expanded states, scroll position, zoom level). |
| schedule | Retrieves this VisualElement's IVisualElementScheduler |
| shadow | Access to this element physical hierarchy |
| style | Reference to the style object of this element. |
| this[int] | Access to this element physical hierarchy |
| userData | This property can be used to associate application-specific user data with this VisualElement. |
| Add | Add an element to this element's contentContainer |
| AddStyleSheetPath | Adds this stylesheet file to this element list of applied styles |
| AnyDirty | Checks if any of the ChangeTypes have been marked dirty. |
| 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 |
| Clear | Remove all child elements from this element's contentContainer |
| Contains | Returns true if the element is a direct child of this VisualElement |
| ElementAt | Retrieves the child element at position |
| FindAncestorUserData | Searchs up the hierachy of this VisualElement and retrieves stored userData, if any is found. |
| FindCommonAncestor | Finds the lowest commont ancestor between two VisualElements inside the VisualTree hierarchy |
| GetEnumerator | Allows to iterate into this elements children |
| 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 |
| GetFullHierarchicalPersistenceKey | Combine this VisualElement's VisualElement.persistenceKey with those of its parents to create a more unique key for use with VisualElement.GetOrCreatePersistentData. |
| GetOrCreatePersistentData | Takes a reference to an existing persisted object and a key and returns the object either filled with the persisted state or as-is. |
| HasStyleSheetPath | Checks if this stylesheet file is in this element list of applied styles |
| Insert | Insert an element into this element's contentContainer |
| OnPersistentDataReady | Called when the persistent data is accessible and/or when the data or persistence key have changed (VisualElement is properly parented). |
| OverwriteFromPersistedData | Overwrite object from the persistent data store. |
| 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. |
| Remove | Removes this child from the hierarchy |
| RemoveAt | Remove the child element located at this position from this element's contentContainer |
| RemoveFromHierarchy | Removes this element from its parent hierarchy |
| RemoveStyleSheetPath | Removes this stylesheet file from this element list of applied styles |
| SavePersistentData | Write persistence data to file. |
| SendToBack | Sends this element to the beginning of its parent children list. The element will be visually behind any overlapping sibling elements. |
| SetEnabled | Changes the VisualElement enabled state. A disabled VisualElement does not receive most events. |
| Sort | Reorders child elements from this VisualElement contentContainer. |
| OnStyleResolved | Callback when the styles of an object have changed. |
| canGrabFocus | Return true if the element can be focused. |
| focusController | Return the focus controller for this element. |
| focusIndex | An integer used to sort focusables in the focus ring. A negative value means that the element can not be focused. |
| HandleEvent | Handle an event, most often by executing the callbacks associated with the event. |
| HasBubbleHandlers | Return true if event handlers for the event propagation bubble up phase have been attached on this object. |
| HasCaptureHandlers | Return true if event handlers for the event propagation capture phase have been attached on this object. |
| RegisterCallback | Add 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. |
| UnregisterCallback | Remove callback from the instance. |
| Blur | Tell the element to release the focus. |
| Focus | Attempt to give the focus to this element. |
Did you find this page useful? Please give it a rating: