Class TextValueField<TValueType>.TextValueInput

This is the inner representation of the Text input.

Inheritance
Object
CallbackEventHandler
Focusable
VisualElement
TextInputBaseField.TextInputBase<>
TextValueField<TValueType>.TextValueInput
Inherited Members
Namespace: UnityEditor.UIElements
Syntax
protected abstract class TextValueInput : TextInputBaseField<TValueType>.TextInputBase, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, ITextInputField, IEventHandler, ITextElement

Constructors

TextValueInput()

Declaration
protected TextValueInput()

Properties

allowedCharacters

Method to override to indicate the allowed characters in the actual field.

Declaration
protected abstract string allowedCharacters { get; }
Property Value
Type Description
String

formatString

Formats the string.

Declaration
public string formatString { get; set; }
Property Value
Type Description
String

Methods

ApplyInputDeviceDelta(Vector3, DeltaSpeed, TValueType)

Called when the user is dragging the label to update the value contained in the field.

Declaration
public abstract void ApplyInputDeviceDelta(Vector3 delta, DeltaSpeed speed, TValueType startValue)
Parameters
Type Name Description
Vector3 delta

Delta on the move.
DeltaSpeed speed

Speed of the move.
TValueType startValue

Starting value.

ExecuteDefaultAction(EventBase)

Declaration
protected override void ExecuteDefaultAction(EventBase evt)
Parameters
Type Name Description
EventBase evt
Overrides
UnityEngine.UIElements.TextInputBaseField<TValueType>.TextInputBase.ExecuteDefaultAction(UnityEngine.UIElements.EventBase)

ExecuteDefaultActionAtTarget(EventBase)

Declaration
protected override void ExecuteDefaultActionAtTarget(EventBase evt)
Parameters
Type Name Description
EventBase evt
Overrides
UnityEngine.UIElements.TextInputBaseField<TValueType>.TextInputBase.ExecuteDefaultActionAtTarget(UnityEngine.UIElements.EventBase)

StartDragging()

Method called by the application when the label of the field is started to be dragged to change the value of it.

Declaration
public void StartDragging()

StopDragging()

Method called by the application when the label of the field is stopped to be dragged to change the value of it.

Declaration
public void StopDragging()

StringToValue(String)

Converts a string to a value type.

Declaration
protected override TValueType StringToValue(string str)
Parameters
Type Name Description
String str

The string to convert.
Returns
Type Description
TValueType

The value parsed from the string.
Overrides
UnityEngine.UIElements.TextInputBaseField<TValueType>.TextInputBase.StringToValue(System.String)

ValueToString(TValueType)

Convert the value to string for visual representation.

Declaration
protected abstract string ValueToString(TValueType value)
Parameters
Type Name Description
TValueType value

Value to convert.
Returns
Type Description
String

String representation.

Extension Methods