Class TMP_InputField
Editable text input field.
Implements
Inherited Members
Namespace: TMPro
Assembly: solution.dll
Syntax
[AddComponentMenu("UI/TextMeshPro - Input Field", 11)]
public class TMP_InputField : Selectable, IMoveHandler, IPointerDownHandler, IPointerUpHandler, IPointerEnterHandler, IPointerExitHandler, ISelectHandler, IDeselectHandler, IUpdateSelectedHandler, IBeginDragHandler, IDragHandler, IEndDragHandler, IPointerClickHandler, ISubmitHandler, ICanvasElement, ILayoutElement, IScrollHandler, IEventSystemHandlerConstructors
| Name | Description |
|---|---|
| TMP_InputField() |
Fields
Properties
| Name | Description |
|---|---|
| asteriskChar | |
| caretBlinkRate | |
| caretColor | |
| 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 |
| caretPositionInternal | Current position of the cursor. Getters are public Setters are protected |
| caretSelectPositionInternal | |
| caretWidth | |
| characterLimit | |
| characterValidation | |
| contentType | |
| customCaretColor | |
| flexibleHeight | See ILayoutElement.flexibleHeight. |
| flexibleWidth | See ILayoutElement.flexibleWidth. |
| fontAsset | Sets the Font Asset on both Placeholder and Input child objects. |
| inputType | |
| inputValidator | Sets the Input Validation to use a Custom Input Validation script. |
| isFocused | |
| isRichTextEditingAllowed | Is Rich Text editing allowed? |
| keyboardType | |
| layoutPriority | See ILayoutElement.layoutPriority. |
| lineLimit | Limits the number of lines of text in the Input Field. |
| lineType | |
| mesh | |
| minHeight | See ILayoutElement.minHeight. |
| minWidth | See ILayoutElement.minWidth. |
| multiLine | |
| onDeselect | |
| onEndEdit | |
| onEndTextSelection | |
| onFocusSelectAll | Determines if the whole text will be selected when focused. |
| onSelect | |
| onSubmit | |
| onTextSelection | |
| onTouchScreenKeyboardStatusChanged | |
| onValidateInput | |
| onValueChanged | |
| placeholder | |
| pointSize | Set the point size on both Placeholder and Input text object. |
| preferredHeight | Get the height of all the text if constrained to the height of the RectTransform. |
| preferredWidth | Get the displayed with of all input characters. |
| readOnly | |
| resetOnDeActivation | Determines if the text and caret position as well as selection will be reset when the input field is deactivated. |
| restoreOriginalTextOnEscape | Controls whether the original text is restored when pressing "ESC". |
| richText | |
| scrollSensitivity | |
| selectionAnchorPosition | Get: Returns the fixed position of selection Set: If compositionString is 0 set the fixed position |
| selectionColor | |
| selectionFocusPosition | Get: Returns the variable position of selection Set: If compositionString is 0 set the variable position |
| selectionStringAnchorPosition | The fixed position of the selection in the raw string which may contains rich text. |
| selectionStringFocusPosition | The variable position of the selection in the raw string which may contains rich text. |
| shouldHideMobileInput | Should the mobile keyboard input be hidden. |
| shouldHideSoftKeyboard | |
| stringPosition | |
| stringPositionInternal | |
| stringSelectPositionInternal | |
| text | Input field's current text value. This is not necessarily the same as what is visible on screen. |
| textComponent | |
| textViewport | |
| verticalScrollbar | |
| wasCanceled |