メインコンテンツまでスキップ

Class YauiInputField

An editable text: a selectable that shows its text in a Yaui.YauiText, with a caret and a selection, keyboard editing (with the clipboard), IME composition and the on-screen keyboard of mobile platforms. Selecting it starts editing; Enter (single line), Escape or deselecting ends it.

Assembly: Yaui.dll​
View Source​
Declaration
public class YauiInputField : YauiSelectable, IPointerEnterHandler, IPointerExitHandler, IPointerDownHandler, IPointerUpHandler, ISelectHandler, IDeselectHandler, IMoveHandler, IPointerClickHandler, IBeginDragHandler, IDragHandler, IEndDragHandler, IUpdateSelectedHandler, ISubmitHandler

Inheritance: System.Object -> Yaui.YauiSelectable

Implements:

Expand

IPointerEnterHandler, IPointerExitHandler, IPointerDownHandler, IPointerUpHandler, ISelectHandler, IDeselectHandler, IMoveHandler, IPointerClickHandler, IBeginDragHandler, IDragHandler, IEndDragHandler, IUpdateSelectedHandler, ISubmitHandler

Properties​

Text​

View Source​
Declaration
public string Text { get; set; }

TextComponent​

View Source​
Declaration
public YauiText TextComponent { get; set; }

Placeholder​

View Source​
Declaration
public YauiElement Placeholder { get; set; }

CharacterLimit​

View Source​
Declaration
public int CharacterLimit { get; set; }

LineType​

View Source​
Declaration
public InputLineType LineType { get; set; }

ContentType​

View Source​
Declaration
public InputContentType ContentType { get; set; }

KeyboardType​

View Source​
Declaration
public TouchScreenKeyboardType KeyboardType { get; set; }

ReadOnly​

View Source​
Declaration
public bool ReadOnly { get; set; }

SelectAllOnFocus​

View Source​
Declaration
public bool SelectAllOnFocus { get; set; }

CaretColor​

View Source​
Declaration
public Color CaretColor { get; set; }

CaretWidth​

View Source​
Declaration
public float CaretWidth { get; set; }

CaretBlinkRate​

View Source​
Declaration
public float CaretBlinkRate { get; set; }

SelectionColor​

View Source​
Declaration
public Color SelectionColor { get; set; }

OnValueChanged​

View Source​
Declaration
public YauiInputField.InputEvent OnValueChanged { get; set; }

OnEndEdit​

View Source​
Declaration
public YauiInputField.InputEvent OnEndEdit { get; set; }

OnSubmitText​

View Source​
Declaration
public YauiInputField.InputEvent OnSubmitText { get; set; }

IsFocused​

Whether the field is being edited.

View Source​
Declaration
public bool IsFocused { get; }

CaretPosition​

The caret, as an index into Yaui.YauiInputField.Text.

View Source​
Declaration
public int CaretPosition { get; set; }

SelectionAnchor​

The other end of the selection (the caret if nothing is selected).

View Source​
Declaration
public int SelectionAnchor { get; set; }

SelectedText​

The selected text, or empty.

View Source​
Declaration
public string SelectedText { get; }

Methods​

SetTextWithoutNotify(string)​

View Source​
Declaration
public void SetTextWithoutNotify(string value)
Parameters​
TypeName
System.Stringvalue

OnEnable()​

View Source​
Declaration
protected override void OnEnable()

OnDisable()​

View Source​
Declaration
protected override void OnDisable()

OnDestroy()​

View Source​
Declaration
protected virtual void OnDestroy()

OnValidate()​

View Source​
Declaration
protected override void OnValidate()

ActivateInputField()​

Starts editing, if the field is interactable.

View Source​
Declaration
public void ActivateInputField()

DeactivateInputField()​

Ends editing and invokes Yaui.YauiInputField.OnEndEdit.

View Source​
Declaration
public void DeactivateInputField()

SelectAll()​

View Source​
Declaration
public void SelectAll()

OnSelect(BaseEventData)​

View Source​
Declaration
public override void OnSelect(BaseEventData eventData)
Parameters​
TypeName
BaseEventDataeventData

OnDeselect(BaseEventData)​

View Source​
Declaration
public override void OnDeselect(BaseEventData eventData)
Parameters​
TypeName
BaseEventDataeventData

OnSubmit(BaseEventData)​

View Source​
Declaration
public virtual void OnSubmit(BaseEventData eventData)
Parameters​
TypeName
BaseEventDataeventData

OnMove(AxisEventData)​

View Source​
Declaration
public override void OnMove(AxisEventData eventData)
Parameters​
TypeName
AxisEventDataeventData

OnPointerDown(PointerEventData)​

View Source​
Declaration
public override void OnPointerDown(PointerEventData eventData)
Parameters​
TypeName
PointerEventDataeventData

OnPointerClick(PointerEventData)​

View Source​
Declaration
public virtual void OnPointerClick(PointerEventData eventData)
Parameters​
TypeName
PointerEventDataeventData

OnBeginDrag(PointerEventData)​

View Source​
Declaration
public virtual void OnBeginDrag(PointerEventData eventData)
Parameters​
TypeName
PointerEventDataeventData

OnDrag(PointerEventData)​

View Source​
Declaration
public virtual void OnDrag(PointerEventData eventData)
Parameters​
TypeName
PointerEventDataeventData

OnEndDrag(PointerEventData)​

View Source​
Declaration
public virtual void OnEndDrag(PointerEventData eventData)
Parameters​
TypeName
PointerEventDataeventData

OnUpdateSelected(BaseEventData)​

Sent every frame to the selected object: the keyboard and the IME.

View Source​
Declaration
public virtual void OnUpdateSelected(BaseEventData eventData)
Parameters​
TypeName
BaseEventDataeventData

Implements​

  • IPointerEnterHandler
  • IPointerExitHandler
  • IPointerDownHandler
  • IPointerUpHandler
  • ISelectHandler
  • IDeselectHandler
  • IMoveHandler
  • IPointerClickHandler
  • IBeginDragHandler
  • IDragHandler
  • IEndDragHandler
  • IUpdateSelectedHandler
  • ISubmitHandler