class in UnityEngine.Experimental.UIElements
/
Inherits from:Experimental.UIElements.BaseField_1
/
Implemented in:UnityEngine.UIElementsModule
This is the Toggle field.
| text | Optional text after the toggle. |
| defaultFocusIndex | The default focus index for newly created elements. |
| value | The value associated with the field. |
| binding | Binding object that will be updated. |
| bindingPath | Path of the target property to be bound. |
| 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. |
| 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 |
| tooltip | Text to display inside an information box after the user hovers the element for a small amount of time. |
| userData | This property can be used to associate application-specific user data with this VisualElement. |
| SetValueWithoutNotify | Allow to set a value without being of the change, if any. |
| HandleEvent | Handle an event, most often by executing the callbacks associated with the event. |
| HasBubbleUpHandlers | Return true if event handlers for the event propagation BubbleUp phase have been attached on this object. |
| HasTrickleDownHandlers | Returns true if event handlers, for the event propagation TrickleDown phase, are attached to this object. |
| RegisterCallback | Adds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect. |
| SendEvent | Sends an event to the event handler. |
| UnregisterCallback | Remove callback from the instance. |
| Blur | Tell the element to release the focus. |
| Focus | Attempt to give the focus to this element. |
| Add | Add an element to this element's contentContainer |
| AddStyleSheetPath | Adds this stylesheet file to this element list of applied styles |
| 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 |
| EnableInClassList | Enables or disables the class with the given name. |
| 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 |
| IndexOf | Retrieves the child index of the specified VisualElement. |
| Insert | Insert an element into this element's contentContainer |
| MarkDirtyRepaint | Triggers a repaint of the VisualElement on the next frame. |
| 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. |
| SendEvent | Sends an event to the event handler. |
| SendToBack | Sends this element to the beginning of its parent children list. The element will be visually behind any overlapping sibling elements. |
| SetEnabled | Changes whether the current VisualElement is enabled or not. When disabled, a VisualElement does not receive most events. |
| Sort | Reorders child elements from this VisualElement contentContainer. |
| ToggleInClassList | Toggles between adding and removing the given class name from the class list. |
| OnStyleResolved | Callback when the styles of an object have changed. |