Show / Hide Table of Contents

Class TextField

Inheritance
Object
CallbackEventHandler
Focusable
VisualElement
BindableElement
BaseField<String>
TextInputFieldBase<String>
TextField
Implements
ITransform
IUIElementDataWatch
IEnumerable<VisualElement>
IEnumerable
IVisualElementScheduler
IStyle
IBindable
INotifyValueChanged<String>
IEventHandler
Inherited Members
TextInputFieldBase<String>.text
TextInputFieldBase<String>.SelectAll()
TextInputFieldBase<String>.selectionColor
TextInputFieldBase<String>.cursorColor
TextInputFieldBase<String>.cursorIndex
TextInputFieldBase<String>.selectIndex
TextInputFieldBase<String>.maxLength
TextInputFieldBase<String>.doubleClickSelectsWord
TextInputFieldBase<String>.tripleClickSelectsLine
TextInputFieldBase<String>.isDelayed
TextInputFieldBase<String>.maskChar
TextInputFieldBase<String>.OnStyleResolved(ICustomStyle)
TextInputFieldBase<String>.BuildContextualMenu(ContextualMenuPopulateEvent)
TextInputFieldBase<String>.DoMeasure(Single, VisualElement.MeasureMode, Single, VisualElement.MeasureMode)
BaseField<String>.m_Value
BaseField<String>.SetValueAndNotify(String)
BaseField<String>.OnValueChanged(EventCallback<ChangeEvent<String>>)
BaseField<String>.RemoveOnValueChanged(EventCallback<ChangeEvent<String>>)
BindableElement.binding
BindableElement.bindingPath
VisualElement.defaultFocusIndex
VisualElement.persistenceKey
VisualElement.userData
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.transform
VisualElement.ITransform.position
VisualElement.ITransform.rotation
VisualElement.ITransform.scale
VisualElement.ITransform.matrix
VisualElement.layout
VisualElement.contentRect
VisualElement.paddingRect
VisualElement.worldBound
VisualElement.localBound
VisualElement.worldTransform
VisualElement.pickingMode
VisualElement.name
VisualElement.Focus()
VisualElement.SendEvent(EventBase)
VisualElement.Dirty(ChangeType)
VisualElement.IsDirty(ChangeType)
VisualElement.AnyDirty(ChangeType)
VisualElement.ClearDirty(ChangeType)
VisualElement.enabled
VisualElement.SetEnabledFromHierarchy(Boolean)
VisualElement.enabledInHierarchy
VisualElement.enabledSelf
VisualElement.SetEnabled(Boolean)
VisualElement.visible
VisualElement.MarkDirtyRepaint()
VisualElement.GetFullHierarchicalPersistenceKey()
VisualElement.GetOrCreatePersistentData<T>(Object, String)
VisualElement.GetOrCreatePersistentData<T>(ScriptableObject, String)
VisualElement.OverwriteFromPersistedData(Object, String)
VisualElement.SavePersistentData()
VisualElement.ContainsPoint(Vector2)
VisualElement.Overlaps(Rect)
VisualElement.SetSize(Vector2)
VisualElement.ResetPositionProperties()
VisualElement.ToString()
VisualElement.ClearClassList()
VisualElement.AddToClassList(String)
VisualElement.RemoveFromClassList(String)
VisualElement.ToggleInClassList(String)
VisualElement.EnableInClassList(String, Boolean)
VisualElement.ClassListContains(String)
VisualElement.FindAncestorUserData()
VisualElement.dataWatch
VisualElement.IUIElementDataWatch.RegisterWatch(Object, Action<Object>)
VisualElement.IUIElementDataWatch.UnregisterWatch(IUIElementDataWatchRequest)
VisualElement.shadow
VisualElement.clippingOptions
VisualElement.parent
VisualElement.panel
VisualElement.contentContainer
VisualElement.Add(VisualElement)
VisualElement.Insert(Int32, VisualElement)
VisualElement.Remove(VisualElement)
VisualElement.RemoveAt(Int32)
VisualElement.Clear()
VisualElement.ElementAt(Int32)
VisualElement.Item[Int32]
VisualElement.childCount
VisualElement.IndexOf(VisualElement)
VisualElement.Children()
VisualElement.Sort(Comparison<VisualElement>)
VisualElement.BringToFront()
VisualElement.SendToBack()
VisualElement.PlaceBehind(VisualElement)
VisualElement.PlaceInFront(VisualElement)
VisualElement.RemoveFromHierarchy()
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.Contains(VisualElement)
VisualElement.FindCommonAncestor(VisualElement)
VisualElement.GetEnumerator()
VisualElement.IEnumerable.GetEnumerator()
VisualElement.schedule
VisualElement.IVisualElementScheduler.Execute(Action<TimerState>)
VisualElement.IVisualElementScheduler.Execute(Action)
VisualElement.style
VisualElement.IStyle.width
VisualElement.IStyle.height
VisualElement.IStyle.maxWidth
VisualElement.IStyle.maxHeight
VisualElement.IStyle.minWidth
VisualElement.IStyle.minHeight
VisualElement.IStyle.flex
VisualElement.IStyle.flexBasis
VisualElement.IStyle.flexGrow
VisualElement.IStyle.flexShrink
VisualElement.IStyle.overflow
VisualElement.IStyle.positionLeft
VisualElement.IStyle.positionTop
VisualElement.IStyle.positionRight
VisualElement.IStyle.positionBottom
VisualElement.IStyle.marginLeft
VisualElement.IStyle.marginTop
VisualElement.IStyle.marginRight
VisualElement.IStyle.marginBottom
VisualElement.IStyle.borderLeft
VisualElement.IStyle.borderTop
VisualElement.IStyle.borderRight
VisualElement.IStyle.borderBottom
VisualElement.IStyle.borderLeftWidth
VisualElement.IStyle.borderTopWidth
VisualElement.IStyle.borderRightWidth
VisualElement.IStyle.borderBottomWidth
VisualElement.IStyle.borderRadius
VisualElement.IStyle.borderTopLeftRadius
VisualElement.IStyle.borderTopRightRadius
VisualElement.IStyle.borderBottomRightRadius
VisualElement.IStyle.borderBottomLeftRadius
VisualElement.IStyle.paddingLeft
VisualElement.IStyle.paddingTop
VisualElement.IStyle.paddingRight
VisualElement.IStyle.paddingBottom
VisualElement.IStyle.positionType
VisualElement.IStyle.alignSelf
VisualElement.IStyle.textAlignment
VisualElement.IStyle.unityTextAlign
VisualElement.IStyle.fontStyle
VisualElement.IStyle.fontStyleAndWeight
VisualElement.IStyle.textClipping
VisualElement.IStyle.font
VisualElement.IStyle.fontSize
VisualElement.IStyle.wordWrap
VisualElement.IStyle.textColor
VisualElement.IStyle.color
VisualElement.IStyle.flexDirection
VisualElement.IStyle.backgroundColor
VisualElement.IStyle.borderColor
VisualElement.IStyle.backgroundImage
VisualElement.IStyle.backgroundSize
VisualElement.IStyle.backgroundScaleMode
VisualElement.IStyle.alignItems
VisualElement.IStyle.alignContent
VisualElement.IStyle.justifyContent
VisualElement.IStyle.flexWrap
VisualElement.IStyle.sliceLeft
VisualElement.IStyle.sliceTop
VisualElement.IStyle.sliceRight
VisualElement.IStyle.sliceBottom
VisualElement.IStyle.opacity
VisualElement.IStyle.cursor
VisualElement.IStyle.visibility
VisualElement.AddStyleSheetPath(String)
VisualElement.RemoveStyleSheetPath(String)
VisualElement.HasStyleSheetPath(String)
VisualElement.tooltip
Focusable.focusIndex
Focusable.Blur()
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, Capture)
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, Capture)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, Capture)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, Capture)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
CallbackEventHandler.HandleEvent(EventBase)
CallbackEventHandler.HasTrickleDownHandlers()
CallbackEventHandler.HasBubbleUpHandlers()
CallbackEventHandler.HasCaptureHandlers()
CallbackEventHandler.HasBubbleHandlers()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: UnityEngine.Experimental.UIElements
Assembly: UnityEngine.dll
Syntax
public class TextField : TextInputFieldBase<string>, ITransform, IUIElementDataWatch, IEnumerable<VisualElement>, IEnumerable, IVisualElementScheduler, IStyle, IBindable, INotifyValueChanged<string>, ITextInputField, IEventHandler, ITextElement

Constructors

| Improve this Doc View Source

TextField()

Declaration
public TextField()
| Improve this Doc View Source

TextField(Int32, Boolean, Boolean, Char)

Declaration
public TextField(int maxLength, bool multiline, bool isPasswordField, char maskChar)
Parameters
Type Name Description
Int32 maxLength
Boolean multiline
Boolean isPasswordField
Char maskChar

Properties

| Improve this Doc View Source

isPasswordField

Declaration
public override bool isPasswordField { set; }
Property Value
Type Description
Boolean
Overrides
UnityEngine.Experimental.UIElements.TextInputFieldBase<System.String>.isPasswordField
| Improve this Doc View Source

multiline

Declaration
public bool multiline { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

value

Declaration
public override string value { get; set; }
Property Value
Type Description
String
Overrides
UnityEngine.Experimental.UIElements.BaseField<System.String>.value

Methods

| Improve this Doc View Source

DoRepaint(IStylePainter)

Declaration
protected override void DoRepaint(IStylePainter painter)
Parameters
Type Name Description
IStylePainter painter
Overrides
UnityEngine.Experimental.UIElements.TextInputFieldBase<System.String>.DoRepaint(UnityEngine.Experimental.UIElements.IStylePainter)
| Improve this Doc View Source

ExecuteDefaultAction(EventBase)

Declaration
protected override void ExecuteDefaultAction(EventBase evt)
Parameters
Type Name Description
EventBase evt
Overrides
UnityEngine.Experimental.UIElements.TextInputFieldBase<System.String>.ExecuteDefaultAction(UnityEngine.Experimental.UIElements.EventBase)
| Improve this Doc View Source

ExecuteDefaultActionAtTarget(EventBase)

Declaration
protected override void ExecuteDefaultActionAtTarget(EventBase evt)
Parameters
Type Name Description
EventBase evt
Overrides
UnityEngine.Experimental.UIElements.TextInputFieldBase<System.String>.ExecuteDefaultActionAtTarget(UnityEngine.Experimental.UIElements.EventBase)
| Improve this Doc View Source

OnPersistentDataReady()

Declaration
public override void OnPersistentDataReady()
Overrides
UnityEngine.Experimental.UIElements.BaseField<System.String>.OnPersistentDataReady()
| Improve this Doc View Source

SelectRange(Int32, Int32)

Declaration
public void SelectRange(int cursorIndex, int selectionIndex)
Parameters
Type Name Description
Int32 cursorIndex
Int32 selectionIndex
| Improve this Doc View Source

SetValueWithoutNotify(String)

Declaration
public override void SetValueWithoutNotify(string newValue)
Parameters
Type Name Description
String newValue
Overrides
UnityEngine.Experimental.UIElements.BaseField<System.String>.SetValueWithoutNotify(System.String)

Implements

ITransform
IUIElementDataWatch
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable
IVisualElementScheduler
IStyle
IBindable
INotifyValueChanged<T>
IEventHandler

Extension Methods

IBindingExtensions.IsBound(IBindable)
MouseCaptureController.HasMouseCapture(IEventHandler)
MouseCaptureController.TakeMouseCapture(IEventHandler)
MouseCaptureController.CaptureMouse(IEventHandler)
MouseCaptureController.ReleaseMouseCapture(IEventHandler)
MouseCaptureController.ReleaseMouse(IEventHandler)
UQueryExtensions.Q<T>(VisualElement, String, String[])
UQueryExtensions.Q<T>(VisualElement, String, String)
UQueryExtensions.Q(VisualElement, String, String[])
UQueryExtensions.Q(VisualElement, String, String)
UQueryExtensions.Query(VisualElement, String, String[])
UQueryExtensions.Query(VisualElement, String, String)
UQueryExtensions.Query<T>(VisualElement, String, String[])
UQueryExtensions.Query<T>(VisualElement, String, String)
UQueryExtensions.Query(VisualElement)
VisualElementExtensions.WorldToLocal(VisualElement, Vector2)
VisualElementExtensions.LocalToWorld(VisualElement, Vector2)
VisualElementExtensions.WorldToLocal(VisualElement, Rect)
VisualElementExtensions.LocalToWorld(VisualElement, Rect)
VisualElementExtensions.ChangeCoordinatesTo(VisualElement, VisualElement, Vector2)
VisualElementExtensions.ChangeCoordinatesTo(VisualElement, VisualElement, Rect)
VisualElementExtensions.StretchToParentSize(VisualElement)
VisualElementExtensions.StretchToParentWidth(VisualElement)
VisualElementExtensions.AddManipulator(VisualElement, IManipulator)
VisualElementExtensions.RemoveManipulator(VisualElement, IManipulator)
MustExtensions.MustBeEqual<T>(T, T)
MustExtensions.MustBeEqual<T>(T, T, String)
MustExtensions.MustNotBeEqual<T>(T, T)
MustExtensions.MustNotBeEqual<T>(T, T, String)
MustExtensions.MustBeNull<T>(T)
MustExtensions.MustBeNull<T>(T, String)
MustExtensions.MustNotBeNull<T>(T)
MustExtensions.MustNotBeNull<T>(T, String)
BindingExtensions.Bind(VisualElement, SerializedObject)
BindingExtensions.Unbind(VisualElement)
BindingExtensions.BindProperty(IBindable, SerializedObject)
BindingExtensions.BindProperty(IBindable, SerializedProperty)
  • Improve this Doc
  • View Source
Back to top Generated by DocFX