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


class in UnityEngine.Experimental.UIElements





A textfield is a rectangular area where the user can edit a string.


cursorColorThe color of the cursor.
doubleClickSelectsWordSet this to true to allow double-clicks to select the word under the mouse and false if otherwise.
hasFocusReturns true if the textfield has the focus and false if otherwise.
isPasswordFieldSet this to true to mask the characters and false if otherwise.
maskCharThe character used for masking in a password field.
maxLengthThe maximum number of characters this textfield can hold. If 0, there is no limit.
multilineSet this to true to allow multiple lines in the textfield and false if otherwise.
OnTextChangedAction that is called whenever the text changes in the textfield.
OnTextChangeValidatedAction that is called when the user validates the text in the textfield.
selectionColorThe color of the text selection.
tripleClickSelectsLineSet this to true to allow triple-clicks to select the line under the mouse and false if otherwise.


TextFieldCreates a new textfield.

Public 関数

OnPersistentDataReadyCalled when the persistent data is accessible and/or when the data or persistence key have changed (VisualElement is properly parented).



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.
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 関数

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.
OnLostCaptureCalled when the element loses the capture. Will be removed in a future version.
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.
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.
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.
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
OnStyleResolvedCallback when the styles of an object have changed.
OverwriteFromPersistedDataOverwrite object from the persistent data store.
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.
SetEnabledChanges the VisualElement enabled state. A disabled VisualElement does not receive most events.
SortReorders child elements from this VisualElement contentContainer.