Class TMP_InputField

Editable text input field.

Inheritance
Object
UIBehaviour
Selectable
TMP_InputField
Inherited Members
UnityEngine.UI.Selectable.OnValidate()
UnityEngine.UI.Selectable.Reset()
UnityEngine.UI.Selectable.animator
Namespace: TMPro
Syntax
[AddComponentMenu("UI/TextMeshPro - Input Field", 11)]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.textmeshpro@3.2")]
public class TMP_InputField : Selectable, IMoveHandler, IPointerDownHandler, IPointerUpHandler, IPointerEnterHandler, IPointerExitHandler, ISelectHandler, IDeselectHandler, IUpdateSelectedHandler, IBeginDragHandler, IDragHandler, IEndDragHandler, IPointerClickHandler, ISubmitHandler, ICanvasElement, ILayoutElement, IScrollHandler, IEventSystemHandler

Constructors

TMP_InputField()

Declaration
protected TMP_InputField()

Fields

isAlert

Determines if the keyboard is opened in alert mode.

Declaration
public bool isAlert
Field Value
Type Description
Boolean

m_CaretPosition

Declaration
protected int m_CaretPosition
Field Value
Type Description
Int32

m_CaretSelectPosition

Declaration
protected int m_CaretSelectPosition
Field Value
Type Description
Int32

m_CaretVisible

Declaration
protected bool m_CaretVisible
Field Value
Type Description
Boolean

m_CursorVerts

Declaration
protected UIVertex[] m_CursorVerts
Field Value
Type Description
UIVertex[]

m_GlobalFontAsset

Declaration
[SerializeField]
protected FontAsset m_GlobalFontAsset
Field Value
Type Description
UnityEngine.TextCore.Text.FontAsset

m_InputValidator

Declaration
[SerializeField]
protected TMP_InputValidator m_InputValidator
Field Value
Type Description
TMP_InputValidator

m_isRichTextEditingAllowed

Declaration
[SerializeField]
protected bool m_isRichTextEditingAllowed
Field Value
Type Description
Boolean

m_isSelectAll

Declaration
protected bool m_isSelectAll
Field Value
Type Description
Boolean

m_LineLimit

Declaration
[SerializeField]
protected int m_LineLimit
Field Value
Type Description
Int32

m_Mesh

Declaration
[NonSerialized]
protected Mesh m_Mesh
Field Value
Type Description
Mesh

m_OnFocusSelectAll

Declaration
[SerializeField]
protected bool m_OnFocusSelectAll
Field Value
Type Description
Boolean

m_Placeholder

Declaration
[SerializeField]
protected Graphic m_Placeholder
Field Value
Type Description
Graphic

m_RectTransform

Text Text used to display the input's value.

Declaration
protected RectTransform m_RectTransform
Field Value
Type Description
RectTransform

m_ResetOnDeActivation

Declaration
[SerializeField]
protected bool m_ResetOnDeActivation
Field Value
Type Description
Boolean

m_ScrollSensitivity

Declaration
[SerializeField]
protected float m_ScrollSensitivity
Field Value
Type Description
Single

m_SoftKeyboard

Declaration
protected TouchScreenKeyboard m_SoftKeyboard
Field Value
Type Description
TouchScreenKeyboard

m_StringPosition

Declaration
protected int m_StringPosition
Field Value
Type Description
Int32

m_StringSelectPosition

Declaration
protected int m_StringSelectPosition
Field Value
Type Description
Int32

m_Text

Input field's value.

Declaration
[SerializeField]
[TextArea(5, 10)]
protected string m_Text
Field Value
Type Description
String

m_TextComponent

Declaration
[SerializeField]
protected TMP_Text m_TextComponent
Field Value
Type Description
TMP_Text

m_TextComponentRectMask

Declaration
protected RectMask2D m_TextComponentRectMask
Field Value
Type Description
RectMask2D

m_TextComponentRectTransform

Declaration
protected RectTransform m_TextComponentRectTransform
Field Value
Type Description
RectTransform

m_TextViewport

Declaration
[SerializeField]
protected RectTransform m_TextViewport
Field Value
Type Description
RectTransform

m_TextViewportRectMask

Declaration
protected RectMask2D m_TextViewportRectMask
Field Value
Type Description
RectMask2D

m_VerticalScrollbar

Declaration
[SerializeField]
protected Scrollbar m_VerticalScrollbar
Field Value
Type Description
Scrollbar

m_VerticalScrollbarEventHandler

Declaration
[SerializeField]
protected TMP_ScrollbarEventHandler m_VerticalScrollbarEventHandler
Field Value
Type Description
TMP_ScrollbarEventHandler

Properties

asteriskChar

Declaration
public char asteriskChar { get; set; }
Property Value
Type Description
Char

caretBlinkRate

Declaration
public float caretBlinkRate { get; set; }
Property Value
Type Description
Single

caretColor

Declaration
public Color caretColor { get; set; }
Property Value
Type Description
Color

caretPosition

Get: Returns the focus position as thats the position that moves around even during selection. Set: Set both the anchor and focus position such that a selection doesn't happen

Declaration
public int caretPosition { get; set; }
Property Value
Type Description
Int32

caretPositionInternal

Current position of the cursor. Getters are public Setters are protected

Declaration
protected int caretPositionInternal { get; set; }
Property Value
Type Description
Int32

caretSelectPositionInternal

Declaration
protected int caretSelectPositionInternal { get; set; }
Property Value
Type Description
Int32

caretWidth

Declaration
public int caretWidth { get; set; }
Property Value
Type Description
Int32

characterLimit

Declaration
public int characterLimit { get; set; }
Property Value
Type Description
Int32

characterValidation

The type of validation to perform on a character

Declaration
public TMP_InputField.CharacterValidation characterValidation { get; set; }
Property Value
Type Description
TMP_InputField.CharacterValidation

contentType

Declaration
public TMP_InputField.ContentType contentType { get; set; }
Property Value
Type Description
TMP_InputField.ContentType

customCaretColor

Declaration
public bool customCaretColor { get; set; }
Property Value
Type Description
Boolean

flexibleHeight

See ILayoutElement.flexibleHeight.

Declaration
public virtual float flexibleHeight { get; }
Property Value
Type Description
Single
Implements

flexibleWidth

See ILayoutElement.flexibleWidth.

Declaration
public virtual float flexibleWidth { get; }
Property Value
Type Description
Single
Implements

fontAsset

Sets the Font Asset on both Placeholder and Input child objects.

Declaration
public FontAsset fontAsset { get; set; }
Property Value
Type Description
UnityEngine.TextCore.Text.FontAsset

inputType

The type of input expected. See InputField.InputType.

Declaration
public TMP_InputField.InputType inputType { get; set; }
Property Value
Type Description
TMP_InputField.InputType

inputValidator

Sets the Input Validation to use a Custom Input Validation script.

Declaration
public TMP_InputValidator inputValidator { get; set; }
Property Value
Type Description
TMP_InputValidator

isFocused

Declaration
public bool isFocused { get; }
Property Value
Type Description
Boolean

isRichTextEditingAllowed

Is Rich Text editing allowed?

Declaration
public bool isRichTextEditingAllowed { get; set; }
Property Value
Type Description
Boolean

keepTextSelectionVisible

Determines if the text selection will remain visible when the input field looses focus and is deactivated.

Declaration
public bool keepTextSelectionVisible { get; set; }
Property Value
Type Description
Boolean

keyboardType

They type of mobile keyboard that will be used.

Declaration
public TouchScreenKeyboardType keyboardType { get; set; }
Property Value
Type Description
TouchScreenKeyboardType

layoutPriority

See ILayoutElement.layoutPriority.

Declaration
public virtual int layoutPriority { get; }
Property Value
Type Description
Int32
Implements

lineLimit

Limits the number of lines of text in the Input Field.

Declaration
public int lineLimit { get; set; }
Property Value
Type Description
Int32

lineType

Declaration
public TMP_InputField.LineType lineType { get; set; }
Property Value
Type Description
TMP_InputField.LineType

mesh

Declaration
protected Mesh mesh { get; }
Property Value
Type Description
Mesh

minHeight

See ILayoutElement.minHeight.

Declaration
public virtual float minHeight { get; }
Property Value
Type Description
Single
Implements

minWidth

See ILayoutElement.minWidth.

Declaration
public virtual float minWidth { get; }
Property Value
Type Description
Single
Implements

multiLine

Declaration
public bool multiLine { get; }
Property Value
Type Description
Boolean

onDeselect

Declaration
public TMP_InputField.SelectionEvent onDeselect { get; set; }
Property Value
Type Description
TMP_InputField.SelectionEvent

onEndEdit

Declaration
public TMP_InputField.SubmitEvent onEndEdit { get; set; }
Property Value
Type Description
TMP_InputField.SubmitEvent

onEndTextSelection

Declaration
public TMP_InputField.TextSelectionEvent onEndTextSelection { get; set; }
Property Value
Type Description
TMP_InputField.TextSelectionEvent

onFocusSelectAll

Determines if the whole text will be selected when focused.

Declaration
public bool onFocusSelectAll { get; set; }
Property Value
Type Description
Boolean

onSelect

Declaration
public TMP_InputField.SelectionEvent onSelect { get; set; }
Property Value
Type Description
TMP_InputField.SelectionEvent

onSubmit

Declaration
public TMP_InputField.SubmitEvent onSubmit { get; set; }
Property Value
Type Description
TMP_InputField.SubmitEvent

onTextSelection

Declaration
public TMP_InputField.TextSelectionEvent onTextSelection { get; set; }
Property Value
Type Description
TMP_InputField.TextSelectionEvent

onTouchScreenKeyboardStatusChanged

Declaration
public TMP_InputField.TouchScreenKeyboardEvent onTouchScreenKeyboardStatusChanged { get; set; }
Property Value
Type Description
TMP_InputField.TouchScreenKeyboardEvent

onValidateInput

Declaration
public TMP_InputField.OnValidateInput onValidateInput { get; set; }
Property Value
Type Description
TMP_InputField.OnValidateInput

onValueChanged

Declaration
public TMP_InputField.OnChangeEvent onValueChanged { get; set; }
Property Value
Type Description
TMP_InputField.OnChangeEvent

placeholder

Declaration
public Graphic placeholder { get; set; }
Property Value
Type Description
Graphic

pointSize

Set the point size on both Placeholder and Input text object.

Declaration
public float pointSize { get; set; }
Property Value
Type Description
Single

preferredHeight

Get the height of all the text if constrained to the height of the RectTransform.

Declaration
public virtual float preferredHeight { get; }
Property Value
Type Description
Single
Implements

preferredWidth

Get the displayed with of all input characters.

Declaration
public virtual float preferredWidth { get; }
Property Value
Type Description
Single
Implements

readOnly

Declaration
public bool readOnly { get; set; }
Property Value
Type Description
Boolean

resetOnDeActivation

Determines if the text and caret position as well as selection will be reset when the input field is deactivated.

Declaration
public bool resetOnDeActivation { get; set; }
Property Value
Type Description
Boolean

restoreOriginalTextOnEscape

Controls whether the original text is restored when pressing "ESC".

Declaration
public bool restoreOriginalTextOnEscape { get; set; }
Property Value
Type Description
Boolean

richText

Declaration
public bool richText { get; set; }
Property Value
Type Description
Boolean

scrollSensitivity

Declaration
public float scrollSensitivity { get; set; }
Property Value
Type Description
Single

selectionAnchorPosition

Get: Returns the fixed position of selection Set: If compositionString is 0 set the fixed position

Declaration
public int selectionAnchorPosition { get; set; }
Property Value
Type Description
Int32

selectionColor

Declaration
public Color selectionColor { get; set; }
Property Value
Type Description
Color

selectionFocusPosition

Get: Returns the variable position of selection Set: If compositionString is 0 set the variable position

Declaration
public int selectionFocusPosition { get; set; }
Property Value
Type Description
Int32

selectionStringAnchorPosition

The fixed position of the selection in the raw string which may contains rich text.

Declaration
public int selectionStringAnchorPosition { get; set; }
Property Value
Type Description
Int32

selectionStringFocusPosition

The variable position of the selection in the raw string which may contains rich text.

Declaration
public int selectionStringFocusPosition { get; set; }
Property Value
Type Description
Int32

shouldActivateOnSelect

Should the inputfield be automatically activated upon selection.

Declaration
public virtual bool shouldActivateOnSelect { get; set; }
Property Value
Type Description
Boolean

shouldHideMobileInput

Should the mobile keyboard input be hidden.

Declaration
public bool shouldHideMobileInput { get; set; }
Property Value
Type Description
Boolean

shouldHideSoftKeyboard

Declaration
public bool shouldHideSoftKeyboard { get; set; }
Property Value
Type Description
Boolean

stringPosition

Declaration
public int stringPosition { get; set; }
Property Value
Type Description
Int32

stringPositionInternal

Declaration
protected int stringPositionInternal { get; set; }
Property Value
Type Description
Int32

stringSelectPositionInternal

Declaration
protected int stringSelectPositionInternal { get; set; }
Property Value
Type Description
Int32

text

Input field's current text value. This is not necessarily the same as what is visible on screen.

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

Note that null is invalid value for InputField.text.

Examples
using UnityEngine;
using System.Collections;
using UnityEngine.UI; // Required when Using UI elements.

public class Example : MonoBehaviour
{
    public InputField mainInputField;

    public void Start()
    {
        mainInputField.text = "Enter Text Here...";
    }
}

textComponent

Declaration
public TMP_Text textComponent { get; set; }
Property Value
Type Description
TMP_Text

textViewport

Declaration
public RectTransform textViewport { get; set; }
Property Value
Type Description
RectTransform

touchScreenKeyboard

The TouchScreenKeyboard being used to edit the Input Field.

Declaration
public TouchScreenKeyboard touchScreenKeyboard { get; }
Property Value
Type Description
TouchScreenKeyboard

verticalScrollbar

Declaration
public Scrollbar verticalScrollbar { get; set; }
Property Value
Type Description
Scrollbar

wasCanceled

Declaration
public bool wasCanceled { get; }
Property Value
Type Description
Boolean

Methods

ActivateInputField()

Declaration
public void ActivateInputField()

Append(Char)

Declaration
protected virtual void Append(char input)
Parameters
Type Name Description
Char input

Append(String)

Append the specified text to the end of the current.

Declaration
protected virtual void Append(string input)
Parameters
Type Name Description
String input

CalculateLayoutInputHorizontal()

See ILayoutElement.CalculateLayoutInputHorizontal.

Declaration
public virtual void CalculateLayoutInputHorizontal()
Implements

CalculateLayoutInputVertical()

See ILayoutElement.CalculateLayoutInputVertical.

Declaration
public virtual void CalculateLayoutInputVertical()
Implements

ClampCaretPos(ref Int32)

Declaration
protected void ClampCaretPos(ref int pos)
Parameters
Type Name Description
Int32 pos

ClampStringPos(ref Int32)

Declaration
protected void ClampStringPos(ref int pos)
Parameters
Type Name Description
Int32 pos

DeactivateInputField(Boolean)

Declaration
public void DeactivateInputField(bool clearSelection = false)
Parameters
Type Name Description
Boolean clearSelection

DoStateTransition(Selectable.SelectionState, Boolean)

Declaration
protected override void DoStateTransition(Selectable.SelectionState state, bool instant)
Parameters
Type Name Description
Selectable.SelectionState state
Boolean instant
Overrides

ForceLabelUpdate()

Declaration
public void ForceLabelUpdate()

GraphicUpdateComplete()

Declaration
public virtual void GraphicUpdateComplete()
Implements

IsValidChar(Char)

Declaration
protected virtual bool IsValidChar(char c)
Parameters
Type Name Description
Char c
Returns
Type Description
Boolean

KeyPressed(Event)

Declaration
protected TMP_InputField.EditState KeyPressed(Event evt)
Parameters
Type Name Description
Event evt
Returns
Type Description
TMP_InputField.EditState

LateUpdate()

Update the text based on input.

Declaration
protected virtual void LateUpdate()

LayoutComplete()

Declaration
public virtual void LayoutComplete()
Implements

MoveTextEnd(Boolean)

Move to the end of the text.

Declaration
public void MoveTextEnd(bool shift)
Parameters
Type Name Description
Boolean shift

MoveTextStart(Boolean)

Move to the start of the text.

Declaration
public void MoveTextStart(bool shift)
Parameters
Type Name Description
Boolean shift

MoveToEndOfLine(Boolean, Boolean)

Move to the end of the current line of text.

Declaration
public void MoveToEndOfLine(bool shift, bool ctrl)
Parameters
Type Name Description
Boolean shift
Boolean ctrl

MoveToStartOfLine(Boolean, Boolean)

Move to the start of the current line of text.

Declaration
public void MoveToStartOfLine(bool shift, bool ctrl)
Parameters
Type Name Description
Boolean shift
Boolean ctrl

OnBeginDrag(PointerEventData)

Declaration
public virtual void OnBeginDrag(PointerEventData eventData)
Parameters
Type Name Description
PointerEventData eventData
Implements

OnControlClick()

Declaration
public void OnControlClick()

OnDeselect(BaseEventData)

Declaration
public override void OnDeselect(BaseEventData eventData)
Parameters
Type Name Description
BaseEventData eventData
Overrides

OnDisable()

Declaration
protected override void OnDisable()
Overrides

OnDrag(PointerEventData)

Declaration
public virtual void OnDrag(PointerEventData eventData)
Parameters
Type Name Description
PointerEventData eventData
Implements

OnEnable()

Declaration
protected override void OnEnable()
Overrides

OnEndDrag(PointerEventData)

Declaration
public virtual void OnEndDrag(PointerEventData eventData)
Parameters
Type Name Description
PointerEventData eventData
Implements

OnFocus()

Declaration
protected void OnFocus()

OnPointerClick(PointerEventData)

Declaration
public virtual void OnPointerClick(PointerEventData eventData)
Parameters
Type Name Description
PointerEventData eventData
Implements

OnPointerDown(PointerEventData)

Declaration
public override void OnPointerDown(PointerEventData eventData)
Parameters
Type Name Description
PointerEventData eventData
Overrides

OnScroll(PointerEventData)

Declaration
public virtual void OnScroll(PointerEventData eventData)
Parameters
Type Name Description
PointerEventData eventData
Implements

OnSelect(BaseEventData)

Declaration
public override void OnSelect(BaseEventData eventData)
Parameters
Type Name Description
BaseEventData eventData
Overrides

OnSubmit(BaseEventData)

Declaration
public virtual void OnSubmit(BaseEventData eventData)
Parameters
Type Name Description
BaseEventData eventData
Implements

OnUpdateSelected(BaseEventData)

Declaration
public virtual void OnUpdateSelected(BaseEventData eventData)
Parameters
Type Name Description
BaseEventData eventData
Implements

ProcessEvent(Event)

Declaration
public void ProcessEvent(Event e)
Parameters
Type Name Description
Event e

Rebuild(CanvasUpdate)

Declaration
public virtual void Rebuild(CanvasUpdate update)
Parameters
Type Name Description
CanvasUpdate update
Implements

ReleaseSelection()

Declaration
public void ReleaseSelection()

SelectAll()

Declaration
protected void SelectAll()

SendOnEndEdit()

Submit the input field's text.

Declaration
protected void SendOnEndEdit()

SendOnEndTextSelection()

Declaration
protected void SendOnEndTextSelection()

SendOnFocus()

Declaration
protected void SendOnFocus()

SendOnFocusLost()

Declaration
protected void SendOnFocusLost()

SendOnSubmit()

Declaration
protected void SendOnSubmit()

SendOnTextSelection()

Declaration
protected void SendOnTextSelection()

SendTouchScreenKeyboardStatusChanged()

Declaration
protected void SendTouchScreenKeyboardStatusChanged()

SetGlobalFontAsset(FontAsset)

Function to conveniently set the Font Asset of both Placeholder and Input Field text object.

Declaration
public void SetGlobalFontAsset(FontAsset fontAsset)
Parameters
Type Name Description
UnityEngine.TextCore.Text.FontAsset fontAsset

SetGlobalPointSize(Single)

Function to conveniently set the point size of both Placeholder and Input Field text object.

Declaration
public void SetGlobalPointSize(float pointSize)
Parameters
Type Name Description
Single pointSize

SetTextWithoutNotify(String)

Set Input field's current text value without invoke onValueChanged. This is not necessarily the same as what is visible on screen.

Declaration
public void SetTextWithoutNotify(string input)
Parameters
Type Name Description
String input

UpdateLabel()

Update the visual text Text.

Declaration
protected void UpdateLabel()

Validate(String, Int32, Char)

Validate the specified input.

Declaration
protected char Validate(string text, int pos, char ch)
Parameters
Type Name Description
String text
Int32 pos
Char ch
Returns
Type Description
Char