Version: Unity 6.0 (6000.0)
LanguageEnglish
  • C#

TextValueField<T0>

class in UnityEngine.UIElements

/

Inherits from:UIElements.TextInputBaseField_1

/

Implemented in:UnityEngine.UIElementsModule

Leave feedback

Implements interfaces:IValueField<T0>

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Base class for text fields.

Properties

Description
formatString The format string used to define how numeric values are displayed. The string follows standard .NET formatting conventions.

Public Methods

Description
ApplyInputDeviceDelta Applies the values of a 3D delta and a speed from an input device.
ClearValue Clears the input field value, reverting to the default state. Placeholder text will be shown if it is set.
SetValueWithoutNotify Allow to set the value without being notified.
StartDragging Indicates the user started the mouse dragging for text selection.
StopDragging Indicates the user stopped the mouse dragging for text selection.

Protected Methods

Description
AddLabelDragger Method used to add a mouse dragger on the label for specific numeric fields.

Inherited Members

Static Properties

Description
alignedFieldUssClassName USS class name of elements that are aligned in a inspector element
labelDraggerVariantUssClassName USS class name of labels in elements of this type, when there is a dragger attached on them.
mixedValueLabelUssClassName USS class name of elements that show mixed values
noLabelVariantUssClassName USS class name of elements of this type, when there is no label.
inputUssClassName USS class name of input elements in elements of this type.
labelUssClassName USS class name of labels in elements of this type.
multilineInputUssClassName USS class name of multiline input elements in elements of this type.
placeholderUssClassName USS class name of input elements when placeholder text is shown
singleLineInputUssClassName USS class name of single line input elements in elements of this type.
textInputUssName USS class name of input elements in elements of this type.
ussClassName USS class name of elements of this type.
disabledUssClassName USS class name of local disabled elements.

Properties

Description
label The string representing the label that will appear beside the field. If the string is empty, the label element is removed from the hierarchy. If the string is not empty, the label element is added to the hierarchy.
labelElement This is the Label object that appears beside the input for the field.
mixedValueLabel Read-only label used to give the appearance of editing multiple different values.
rawValue The value of the element.
showMixedValue When set to true, gives the field the appearance of editing multiple different values.