Scripting API

TMP_InputField

class in TMPro · Unity.TextMeshPro · inherits from Selectable

104 of 142 of Unity's members
In Tassix

TextMeshPro's text box: the same editing as the legacy InputField (typing, selection, validation, submit and cancel), with TextMeshPro's options and events. The text component shows the whole text inside a viewport that clips it.

Properties 57

char asteriskChar { get; set; }
float caretBlinkRate { get; set; }
Color caretColor { get; set; }
int caretPosition { get; set; }
int caretWidth { get; set; }
int characterLimit { get; set; }
CharacterValidation characterValidation { get; set; }
ContentType contentType { get; set; }
bool customCaretColor { get; set; }
virtual float flexibleHeight { get; }
virtual float flexibleWidth { get; }
TMP_FontAsset? fontAsset { get; set; }
InputType inputType { get; set; }
TMP_InputValidator? inputValidator { get; set; }
bool isFocused { get; }
bool isRichTextEditingAllowed { get; set; }
TouchScreenKeyboardType keyboardType { get; set; }
virtual int layoutPriority { get; }
int lineLimit { get; set; }
LineType lineType { get; set; }
virtual float minHeight { get; }
virtual float minWidth { get; }
bool multiLine { get; }
SelectionEvent onDeselect { get; set; }
SubmitEvent onEndEdit { get; set; }
TextSelectionEvent onEndTextSelection { get; set; }
bool onFocusSelectAll { get; set; }
SelectionEvent onSelect { get; set; }
SubmitEvent onSubmit { get; set; }
TextSelectionEvent onTextSelection { get; set; }
TouchScreenKeyboardEvent onTouchScreenKeyboardStatusChanged { get; set; }
OnValidateInput? onValidateInput { get; set; }
OnChangeEvent onValueChanged { get; set; }
Graphic? placeholder { get; set; }
float pointSize { get; set; }
virtual float preferredHeight { get; }
virtual float preferredWidth { get; }
bool readOnly { get; set; }
bool resetOnDeActivation { get; set; }
bool restoreOriginalTextOnEscape { get; set; }
bool richText { get; set; }
float scrollSensitivity { get; set; }
int selectionAnchorPosition { get; set; }
Color selectionColor { get; set; }
int selectionFocusPosition { get; set; }
int selectionStringAnchorPosition { get; set; }
int selectionStringFocusPosition { get; set; }
virtual bool shouldActivateOnSelect { get; set; }
bool shouldHideMobileInput { get; set; }
bool shouldHideSoftKeyboard { get; set; }
int stringPosition { get; set; }
string text { get; set; }
TMP_Text? textComponent { get; set; }
RectTransform? textViewport { get; set; }
TouchScreenKeyboard? touchScreenKeyboard { get; }
Scrollbar? verticalScrollbar { get; set; }
bool wasCanceled { get; }

Methods 27

void ActivateInputField()
virtual void CalculateLayoutInputHorizontal()
virtual void CalculateLayoutInputVertical()
void DeactivateInputField(bool clearSelection = false)
void ForceLabelUpdate()
virtual void GraphicUpdateComplete()
virtual void LayoutComplete()
void MoveTextEnd(bool shift)
void MoveTextStart(bool shift)
void MoveToEndOfLine(bool shift, bool ctrl)
void MoveToStartOfLine(bool shift, bool ctrl)
virtual void OnBeginDrag(PointerEventData eventData)
virtual void OnCancel(BaseEventData eventData)
void OnDeselect(BaseEventData eventData)
virtual void OnDrag(PointerEventData eventData)
virtual void OnEndDrag(PointerEventData eventData)
virtual void OnPointerClick(PointerEventData eventData)
void OnPointerDown(PointerEventData eventData)
virtual void OnScroll(PointerEventData eventData)
void OnSelect(BaseEventData eventData)
virtual void OnSubmit(BaseEventData eventData)
virtual void OnUpdateSelected(BaseEventData eventData)
void ProcessEvent(Event e)
virtual void Rebuild(CanvasUpdate update)
void SetGlobalFontAsset(TMP_FontAsset fontAsset)
void SetGlobalPointSize(float pointSize)
void SetTextWithoutNotify(string input)

Not in Tassix yet 38

Append ClampCaretPos ClampStringPos IsValidChar KeyPressed OnControlClick OnFocus OnValidate ReleaseSelection SelectAll SendTouchScreenKeyboardStatusChanged Validate caretPositionInternal caretSelectPositionInternal isAlert keepTextSelectionVisible m_CaretPosition m_CaretSelectPosition m_CaretVisible m_CursorVerts m_GlobalFontAsset m_Mesh m_OnFocusSelectAll m_RectTransform m_ResetOnDeActivation m_ScrollSensitivity m_SoftKeyboard m_StringPosition m_StringSelectPosition m_TextComponentRectMask m_TextComponentRectTransform m_TextViewportRectMask m_VerticalScrollbarEventHandler m_isRichTextEditingAllowed m_isSelectAll mesh stringPositionInternal stringSelectPositionInternal