Inheritance diagram for UnityEngine.UI.InputField:

Collaboration diagram for UnityEngine.UI.InputField:

Classes
class	EndEditEvent

class	OnChangeEvent

class	SubmitEvent

Public Types
enum	ContentType { Standard , Autocorrected , IntegerNumber , DecimalNumber , Alphanumeric , Name , EmailAddress , Password , Pin , Custom }

enum	InputType { Standard , AutoCorrect , Password }

enum	CharacterValidation { None , Integer , Decimal , Alphanumeric , Name , EmailAddress }

enum	LineType { SingleLine , MultiLineSubmit , MultiLineNewline }

enum	Transition { None , ColorTint , SpriteSwap , Animation }

Public Member Functions
void	SetTextWithoutNotify (string input)

void	MoveTextEnd (bool shift)

void	MoveTextStart (bool shift)

Vector2	ScreenToLocal (Vector2 screen)

virtual void	OnBeginDrag (PointerEventData eventData)

virtual void	OnDrag (PointerEventData eventData)

virtual void	OnEndDrag (PointerEventData eventData)

override void	OnPointerDown (PointerEventData eventData)

void	ProcessEvent (Event e)

virtual void	OnUpdateSelected (BaseEventData eventData)

void	ForceLabelUpdate ()

virtual void	Rebuild (CanvasUpdate update)

virtual void	LayoutComplete ()

virtual void	GraphicUpdateComplete ()

void	ActivateInputField ()

override void	OnSelect (BaseEventData eventData)

virtual void	OnPointerClick (PointerEventData eventData)

void	DeactivateInputField ()

override void	OnDeselect (BaseEventData eventData)

virtual void	OnSubmit (BaseEventData eventData)

virtual void	CalculateLayoutInputHorizontal ()

virtual void	CalculateLayoutInputVertical ()

delegate char	OnValidateInput (string text, int charIndex, char addedChar)

virtual bool	IsInteractable ()

Selectable	FindSelectable (Vector3 dir)

virtual Selectable	FindSelectableOnLeft ()

virtual Selectable	FindSelectableOnRight ()

virtual Selectable	FindSelectableOnUp ()

virtual Selectable	FindSelectableOnDown ()

virtual void	OnMove (AxisEventData eventData)

virtual void	OnPointerUp (PointerEventData eventData)

virtual void	OnPointerEnter (PointerEventData eventData)

virtual void	OnPointerExit (PointerEventData eventData)

virtual void	Select ()

virtual bool	IsActive ()

bool	IsDestroyed ()

bool	IsInvoking ()

bool	IsInvoking (string methodName)

void	CancelInvoke ()

void	CancelInvoke (string methodName)

void	Invoke (string methodName, float time)

void	InvokeRepeating (string methodName, float time, float repeatRate)

Coroutine	StartCoroutine (string methodName)

Coroutine	StartCoroutine (string methodName, [DefaultValue("null")] object value)

Coroutine	StartCoroutine (IEnumerator routine)

Coroutine	StartCoroutine_Auto (IEnumerator routine)

void	StopCoroutine (IEnumerator routine)

void	StopCoroutine (Coroutine routine)

void	StopCoroutine (string methodName)

void	StopAllCoroutines ()

Component	GetComponent (Type type)

T	GetComponent< T > ()

Component	GetComponentInChildren (Type t, bool includeInactive)

T	GetComponentInChildren< T > ()

T[]	GetComponentsInChildren< T > (bool includeInactive)

void	GetComponentsInChildren< T > (bool includeInactive, List< T > result)

void	GetComponentsInChildren< T > (List< T > results)

Component	GetComponentInParent (Type t, bool includeInactive)

T	GetComponentInParent< T > ()

T[]	GetComponentsInParent< T > (bool includeInactive)

void	GetComponentsInParent< T > (bool includeInactive, List< T > results)

T[]	GetComponentsInParent< T > ()

void	GetComponents (Type type, List< Component > results)

void	GetComponents< T > (List< T > results)

T[]	GetComponents< T > ()

unsafe int	GetInstanceID ()

override int	GetHashCode ()

override bool	Equals (object other)

static void	Destroy (Object obj, [DefaultValue("0.0F")] float t)

static void	DestroyImmediate (Object obj, [DefaultValue("false")] bool allowDestroyingAssets)

static Object[]	FindObjectsOfType (Type type, bool includeInactive)

static void	DontDestroyOnLoad ([NotNull("NullExceptionObject")] Object target)

override string	ToString ()

bool	IsDestroyed ()

Static Public Member Functions
static int	AllSelectablesNoAlloc (Selectable[] selectables)

static void	print (object message)

static implicit	operator bool (Object exists)

static Object	Instantiate (Object original, Vector3 position, Quaternion rotation)

static Object	Instantiate (Object original)

static T	Instantiate< T > (T original)

static T	Instantiate< T > (T original, Vector3 position, Quaternion rotation)

static void	Destroy (Object obj)

static void	DestroyImmediate (Object obj)

static T[]	FindObjectsOfType< T > ()

static bool	operator== (Object x, Object y)

static bool	operator!= (Object x, Object y)

Protected Types
enum	EditState { Continue , Finish }

enum	SelectionState { Normal , Highlighted , Pressed , Selected , Disabled }

Protected Member Functions
	InputField ()

void	ClampPos (ref int pos)

override void	Awake ()

override void	OnEnable ()

override void	OnDisable ()

override void	OnDestroy ()

void	OnFocus ()

void	SelectAll ()

virtual void	LateUpdate ()

int	GetCharacterIndexFromPosition (Vector2 pos)

InputField.EditState	KeyPressed (Event evt)

void	SendOnEndEdit ()

void	SendOnSubmit ()

virtual void	Append (string input)

virtual void	Append (char input)

void	UpdateLabel ()

char	Validate (string text, int pos, char ch)

override void	DoStateTransition (Selectable.SelectionState state, bool instant)

override void	OnCanvasGroupChanged ()

override void	OnDidApplyAnimationProperties ()

override void	OnTransformParentChanged ()

virtual void	InstantClearState ()

bool	IsHighlighted ()

bool	IsPressed ()

virtual void	Start ()

virtual void	OnRectTransformDimensionsChange ()

virtual void	OnBeforeTransformParentChanged ()

virtual void	OnCanvasHierarchyChanged ()

Protected Attributes
TouchScreenKeyboard	m_Keyboard

Text	m_TextComponent

Graphic	m_Placeholder

string	m_Text

int	m_CaretPosition

int	m_CaretSelectPosition

UIVertex[]	m_CursorVerts

Mesh	m_Mesh

bool	m_CaretVisible

int	m_DrawStart

int	m_DrawEnd

int	m_CurrentIndex

Static Protected Attributes
static Selectable[]	s_Selectables

static int	s_SelectableCount

Package Functions
string	GetScriptClassName ()

void	GetComponentFastPath (Type type, IntPtr oneFurtherThanResultValue)

static Object	FindObjectFromInstanceID (int instanceID)

Static Package Attributes
static int	OffsetOfInstanceIDInCPlusPlusObject

Properties
BaseInput	input `[get, set]`

string	compositionString `[get, set]`

Mesh	mesh `[get, set]`

TextGenerator	cachedInputTextGenerator `[get, set]`

bool	shouldHideMobileInput `[get, set]`

virtual bool	shouldActivateOnSelect `[get, set]`

string	text `[get, set]`

bool	isFocused `[get, set]`

float	caretBlinkRate `[get, set]`

int	caretWidth `[get, set]`

Text	textComponent `[get, set]`

Graphic	placeholder `[get, set]`

Color	caretColor `[get, set]`

bool	customCaretColor `[get, set]`

Color	selectionColor `[get, set]`

InputField.EndEditEvent	onEndEdit `[get, set]`

InputField.SubmitEvent	onSubmit `[get, set]`

InputField.OnChangeEvent	onValueChange `[get, set]`

InputField.OnChangeEvent	onValueChanged `[get, set]`

InputField.OnValidateInput	onValidateInput `[get, set]`

int	characterLimit `[get, set]`

InputField.ContentType	contentType `[get, set]`

InputField.LineType	lineType `[get, set]`

InputField.InputType	inputType `[get, set]`

TouchScreenKeyboard	touchScreenKeyboard `[get, set]`

TouchScreenKeyboardType	keyboardType `[get, set]`

InputField.CharacterValidation	characterValidation `[get, set]`

bool	readOnly `[get, set]`

bool	multiLine `[get, set]`

char	asteriskChar `[get, set]`

bool	wasCanceled `[get, set]`

int	caretPositionInternal `[get, set]`

int	caretSelectPositionInternal `[get, set]`

bool	hasSelection `[get, set]`

int	caretPosition `[get, set]`

int	selectionAnchorPosition `[get, set]`

int	selectionFocusPosition `[get, set]`

static string	clipboard `[get, set]`

virtual float	minWidth `[get, set]`

virtual float	preferredWidth `[get, set]`

virtual float	flexibleWidth `[get, set]`

virtual float	minHeight `[get, set]`

virtual float	preferredHeight `[get, set]`

virtual float	flexibleHeight `[get, set]`

virtual int	layoutPriority `[get, set]`

class< CaretBlink >	IDisposable `[set]`

class< MouseDragOutsideRect >	IDisposable `[set]`

static Selectable[]	allSelectablesArray `[get, set]`

static int	allSelectableCount `[get, set]`

static List< Selectable >	allSelectables `[get, set]`

Navigation	navigation `[get, set]`

Selectable.Transition	transition `[get, set]`

ColorBlock	colors `[get, set]`

SpriteState	spriteState `[get, set]`

AnimationTriggers	animationTriggers `[get, set]`

Graphic	targetGraphic `[get, set]`

bool	interactable `[get, set]`

bool	isPointerInside `[get, set]`

bool	isPointerDown `[get, set]`

Image	image `[get, set]`

Animator	animator `[get, set]`

Selectable.SelectionState	currentSelectionState `[get, set]`

bool	useGUILayout `[get, set]`

bool	enabled `[get, set]`

bool	isActiveAndEnabled `[get, set]`

Transform	transform `[get, set]`

GameObject	gameObject `[get, set]`

string	name `[get, set]`

HideFlags	hideFlags `[set]`

Transform	transform `[get]`

Private Member Functions
void	SetText (string value, bool sendCallback=true)

IEnumerator	CaretBlink ()

void	SetCaretVisible ()

void	SetCaretActive ()

void	UpdateCaretMaterial ()

bool	TouchScreenKeyboardShouldBeUsed ()

bool	InPlaceEditing ()

bool	InPlaceEditingChanged ()

void	UpdateCaretFromKeyboard ()

int	GetUnclampedCharacterLineFromPosition (Vector2 pos, TextGenerator generator)

bool	MayDrag (PointerEventData eventData)

IEnumerator	MouseDragOutsideRect (PointerEventData eventData)

bool	IsValidChar (char c)

string	GetSelectedString ()

int	FindtNextWordBegin ()

void	MoveRight (bool shift, bool ctrl)

int	FindtPrevWordBegin ()

void	MoveLeft (bool shift, bool ctrl)

int	DetermineCharacterLine (int charPos, TextGenerator generator)

int	LineUpCharacterPosition (int originalPos, bool goToFirstChar)

int	LineDownCharacterPosition (int originalPos, bool goToLastChar)

void	MoveDown (bool shift)

void	MoveDown (bool shift, bool goToLastChar)

void	MoveUp (bool shift)

void	MoveUp (bool shift, bool goToFirstChar)

void	Delete ()

void	ForwardSpace ()

void	Backspace ()

void	Insert (char c)

void	UpdateTouchKeyboardFromEditChanges ()

void	SendOnValueChangedAndUpdateLabel ()

void	SendOnValueChanged ()

bool	IsSelectionVisible ()

void	SetDrawRangeToContainCaretPosition (int caretPos)

void	MarkGeometryAsDirty ()

void	UpdateGeometry ()

void	AssignPositioningIfNeeded ()

void	OnFillVBO (Mesh vbo)

void	GenerateCaret (VertexHelper vbo, Vector2 roundingOffset)

void	CreateCursorVerts ()

void	GenerateHighlight (VertexHelper vbo, Vector2 roundingOffset)

void	ActivateInputFieldInternal ()

void	EnforceContentType ()

void	EnforceTextHOverflow ()

void	SetToCustomIfContentTypeIsNot (params InputField.ContentType[] allowedContentTypes)

void	SetToCustom ()

Transform UnityEngine.UI.ICanvasElement.	get_transform ()

void	OnSetProperty ()

void	OnApplicationFocus (bool hasFocus)

void	Navigate (AxisEventData eventData, Selectable sel)

void	StartColorTween (Color targetColor, bool instant)

void	DoSpriteSwap (Sprite newSprite)

void	TriggerAnimation (string triggername)

void	EvaluateAndTransitionToSelectionState ()

static bool	IsInvoking ([NotNull("NullExceptionObject")] MonoBehaviour self, string methodName)

static void	CancelInvoke ([NotNull("NullExceptionObject")] MonoBehaviour self, string methodName)

static void	Internal_CancelInvokeAll ([NotNull("NullExceptionObject")] MonoBehaviour self)

static bool	Internal_IsInvokingAll ([NotNull("NullExceptionObject")] MonoBehaviour self)

static void	InvokeDelayed ([NotNull("NullExceptionObject")] MonoBehaviour self, string methodName, float time, float repeatRate)

static bool	IsObjectMonoBehaviour ([NotNull("NullExceptionObject")] Object obj)

Coroutine	StartCoroutineManaged (string methodName, object value)

Coroutine	StartCoroutineManaged2 (IEnumerator enumerator)

void	StopCoroutineManaged (Coroutine routine)

void	StopCoroutineFromEnumeratorManaged (IEnumerator routine)

void	GetComponentsForListInternal (Type searchType, object resultList)

IntPtr	GetCachedPtr ()

static string	ToString (Object obj)

static int	GetOffsetOfInstanceIDInCPlusPlusObject ()

static Object	Internal_CloneSingle ([NotNull("NullExceptionObject")] Object data)

static string	GetName ([NotNull("NullExceptionObject")] Object obj)

static void	SetName ([NotNull("NullExceptionObject")] Object obj, string name)

static Object	Internal_InstantiateSingle_Injected (Object data, ref Vector3 pos, ref Quaternion rot)

Static Private Member Functions
static int	GetLineStartPosition (TextGenerator gen, int line)

static int	GetLineEndPosition (TextGenerator gen, int line)

static	InputField ()

static Vector3	GetPointOnRectEdge (RectTransform rect, Vector2 dir)

static bool	CompareBaseObjects (Object lhs, Object rhs)

static bool	IsNativeObjectAlive (Object o)

static void	CheckNullArgument (object arg, string message)

static Object	Internal_InstantiateSingle ([NotNull("NullExceptionObject")] Object data, Vector3 pos, Quaternion rot)

Private Attributes
InputField.ContentType	m_ContentType

InputField.InputType	m_InputType

char	m_AsteriskChar

TouchScreenKeyboardType	m_KeyboardType

InputField.LineType	m_LineType

bool	m_HideMobileInput

InputField.CharacterValidation	m_CharacterValidation

int	m_CharacterLimit

InputField.SubmitEvent	m_OnSubmit

InputField.EndEditEvent	m_OnDidEndEdit

InputField.OnChangeEvent	m_OnValueChanged

InputField.OnValidateInput	m_OnValidateInput

Color	m_CaretColor

bool	m_CustomCaretColor

Color	m_SelectionColor

float	m_CaretBlinkRate

int	m_CaretWidth

bool	m_ReadOnly

bool	m_ShouldActivateOnSelect

RectTransform	caretRectTrans

TextGenerator	m_InputTextCache

CanvasRenderer	m_CachedInputRenderer

bool	m_PreventFontCallback

bool	m_AllowInput

bool	m_ShouldActivateNextUpdate

bool	m_UpdateDrag

bool	m_DragPositionOutOfBounds

Coroutine	m_BlinkCoroutine

float	m_BlinkStartTime

Coroutine	m_DragCoroutine

string	m_OriginalText

bool	m_WasCanceled

bool	m_HasDoneFocusTransition

WaitForSecondsRealtime	m_WaitForSecondsRealtime

bool	m_TouchKeyboardAllowsInPlaceEditing

bool	m_IsCompositionActive

Event	m_ProcessingEvent

class< CaretBlink >	d__172: IEnumerator<object>

class< CaretBlink >	IEnumerator

class< MouseDragOutsideRect >	d__194: IEnumerator<object>

class< MouseDragOutsideRect >	IEnumerator

bool	m_EnableCalled

Navigation	m_Navigation

Selectable.Transition	m_Transition

ColorBlock	m_Colors

SpriteState	m_SpriteState

AnimationTriggers	m_AnimationTriggers

bool	m_Interactable

Graphic	m_TargetGraphic

bool	m_GroupsAllowInteraction

bool< isPointerInside >	k__BackingField

bool< isPointerDown >	k__BackingField

bool< hasSelection >	k__BackingField

readonly List< CanvasGroup >	m_CanvasGroupCache

IntPtr	m_CachedPtr

Static Private Attributes
static readonly char[]	kSeparators

static bool	s_IsQuestDeviceEvaluated

static bool	s_IsQuestDevice

const float	kHScrollSpeed = 0.05f

const float	kVScrollSpeed = 0.1f

const string	kEmailSpecialCharacters = "!#$%&'*+-/=?^_`{\|}~"

const string	kOculusQuestDeviceModel = "Oculus Quest"

const int	k_MaxTextLength = 16382

const string	objectIsNullMessage = "The Object you want to instantiate is null."

const string	cloneDestroyedMessage = "Instantiate failed because the clone was destroyed during creation. This can happen if DestroyImmediate is called in MonoBehaviour.Awake."

Detailed Description

Definition at line 16 of file InputField.cs.

The documentation for this class was generated from the following file:

source/UnityEngine.UI/UnityEngine/UI/InputField.cs

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Package Functions

Static Package Attributes

Properties

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description