Class TextField | UIWidgets | 1.5.4-preview.12
docs.unity3d.com
    Show / Hide Table of Contents

    Class TextField

    Inheritance
    Object
    Diagnosticable
    DiagnosticableTree
    CanonicalMixinDiagnosticableTree
    Widget
    StatefulWidget
    TextField
    Inherited Members
    StatefulWidget.createElement()
    Widget.key
    Widget.toStringShort()
    Widget.canUpdate(Widget, Widget)
    CanonicalMixinDiagnosticableTree.pureWidget
    CanonicalMixinDiagnosticableTree.Equals(Object)
    CanonicalMixinDiagnosticableTree.GetHashCode()
    DiagnosticableTree.toStringShallow(String, DiagnosticLevel)
    DiagnosticableTree.toStringDeep(String, String, DiagnosticLevel)
    DiagnosticableTree.toDiagnosticsNode(String, DiagnosticsTreeStyle)
    DiagnosticableTree.debugDescribeChildren()
    Diagnosticable.ToString()
    Diagnosticable.toString(DiagnosticLevel)
    Namespace: Unity.UIWidgets.material
    Syntax
    public class TextField : StatefulWidget

    Constructors

    TextField(Key, TextEditingController, FocusNode, InputDecoration, Boolean, TextInputType, Nullable<TextInputAction>, TextCapitalization, TextStyle, StrutStyle, TextAlign, TextDirection, Boolean, Boolean, Boolean, Nullable<Int32>, Nullable<Int32>, Boolean, Nullable<Int32>, Boolean, ValueChanged<String>, VoidCallback, ValueChanged<String>, List<TextInputFormatter>, Nullable<Boolean>, Nullable<Single>, Radius, Color, Nullable<Brightness>, EdgeInsets, DragStartBehavior, Nullable<Boolean>, GestureTapCallback, InputCounterWidgetBuilder, ScrollPhysics)

    Declaration
    public TextField(Key key = null, TextEditingController controller = null, FocusNode focusNode = null, InputDecoration decoration = null, bool noDecoration = false, TextInputType keyboardType = null, TextInputAction? textInputAction = default(TextInputAction? ), TextCapitalization textCapitalization = TextCapitalization.none, TextStyle style = null, StrutStyle strutStyle = null, TextAlign textAlign = TextAlign.left, TextDirection textDirection = TextDirection.ltr, bool autofocus = false, bool obscureText = false, bool autocorrect = false, int? maxLines, int? minLines = default(int? ), bool expands = false, int? maxLength = default(int? ), bool maxLengthEnforced = true, ValueChanged<string> onChanged = null, VoidCallback onEditingComplete = null, ValueChanged<string> onSubmitted = null, List<TextInputFormatter> inputFormatters = null, bool? enabled = default(bool? ), float? cursorWidth, Radius cursorRadius = null, Color cursorColor = null, Brightness? keyboardAppearance = default(Brightness? ), EdgeInsets scrollPadding = null, DragStartBehavior dragStartBehavior = DragStartBehavior.start, bool? enableInteractiveSelection = default(bool? ), GestureTapCallback onTap = null, InputCounterWidgetBuilder buildCounter = null, ScrollPhysics scrollPhysics = null)
    Parameters
    Type Name Description
    Key key
    TextEditingController controller
    FocusNode focusNode
    InputDecoration decoration
    Boolean noDecoration
    TextInputType keyboardType
    Nullable<TextInputAction> textInputAction
    TextCapitalization textCapitalization
    TextStyle style
    StrutStyle strutStyle
    TextAlign textAlign
    TextDirection textDirection
    Boolean autofocus
    Boolean obscureText
    Boolean autocorrect
    Nullable<Int32> maxLines
    Nullable<Int32> minLines
    Boolean expands
    Nullable<Int32> maxLength
    Boolean maxLengthEnforced
    ValueChanged<String> onChanged
    VoidCallback onEditingComplete
    ValueChanged<String> onSubmitted
    List<TextInputFormatter> inputFormatters
    Nullable<Boolean> enabled
    Nullable<Single> cursorWidth
    Radius cursorRadius
    Color cursorColor
    Nullable<Brightness> keyboardAppearance
    EdgeInsets scrollPadding
    DragStartBehavior dragStartBehavior
    Nullable<Boolean> enableInteractiveSelection
    GestureTapCallback onTap
    InputCounterWidgetBuilder buildCounter
    ScrollPhysics scrollPhysics

    Fields

    autocorrect

    Declaration
    public readonly bool autocorrect
    Field Value
    Type Description
    Boolean

    autofocus

    Declaration
    public readonly bool autofocus
    Field Value
    Type Description
    Boolean

    buildCounter

    Declaration
    public readonly InputCounterWidgetBuilder buildCounter
    Field Value
    Type Description
    InputCounterWidgetBuilder

    controller

    Declaration
    public readonly TextEditingController controller
    Field Value
    Type Description
    TextEditingController

    cursorColor

    Declaration
    public readonly Color cursorColor
    Field Value
    Type Description
    Color

    cursorRadius

    Declaration
    public readonly Radius cursorRadius
    Field Value
    Type Description
    Radius

    cursorWidth

    Declaration
    public readonly float? cursorWidth
    Field Value
    Type Description
    Nullable<Single>

    decoration

    Declaration
    public readonly InputDecoration decoration
    Field Value
    Type Description
    InputDecoration

    dragStartBehavior

    Declaration
    public readonly DragStartBehavior dragStartBehavior
    Field Value
    Type Description
    DragStartBehavior

    enabled

    Declaration
    public readonly bool? enabled
    Field Value
    Type Description
    Nullable<Boolean>

    enableInteractiveSelection

    Declaration
    public readonly bool? enableInteractiveSelection
    Field Value
    Type Description
    Nullable<Boolean>

    expands

    Declaration
    public readonly bool expands
    Field Value
    Type Description
    Boolean

    focusNode

    Declaration
    public readonly FocusNode focusNode
    Field Value
    Type Description
    FocusNode

    inputFormatters

    Declaration
    public readonly List<TextInputFormatter> inputFormatters
    Field Value
    Type Description
    List<TextInputFormatter>

    keyboardAppearance

    Declaration
    public readonly Brightness? keyboardAppearance
    Field Value
    Type Description
    Nullable<Brightness>

    keyboardType

    Declaration
    public readonly TextInputType keyboardType
    Field Value
    Type Description
    TextInputType

    maxLength

    Declaration
    public readonly int? maxLength
    Field Value
    Type Description
    Nullable<Int32>

    maxLengthEnforced

    Declaration
    public readonly bool maxLengthEnforced
    Field Value
    Type Description
    Boolean

    maxLines

    Declaration
    public readonly int? maxLines
    Field Value
    Type Description
    Nullable<Int32>

    minLines

    Declaration
    public readonly int? minLines
    Field Value
    Type Description
    Nullable<Int32>

    noMaxLength

    Declaration
    public const long noMaxLength = -1L
    Field Value
    Type Description
    Int64

    obscureText

    Declaration
    public readonly bool obscureText
    Field Value
    Type Description
    Boolean

    onChanged

    Declaration
    public readonly ValueChanged<string> onChanged
    Field Value
    Type Description
    ValueChanged<String>

    onEditingComplete

    Declaration
    public readonly VoidCallback onEditingComplete
    Field Value
    Type Description
    VoidCallback

    onSubmitted

    Declaration
    public readonly ValueChanged<string> onSubmitted
    Field Value
    Type Description
    ValueChanged<String>

    onTap

    Declaration
    public readonly GestureTapCallback onTap
    Field Value
    Type Description
    GestureTapCallback

    scrollPadding

    Declaration
    public readonly EdgeInsets scrollPadding
    Field Value
    Type Description
    EdgeInsets

    scrollPhysics

    Declaration
    public readonly ScrollPhysics scrollPhysics
    Field Value
    Type Description
    ScrollPhysics

    strutStyle

    Declaration
    public readonly StrutStyle strutStyle
    Field Value
    Type Description
    StrutStyle

    style

    Declaration
    public readonly TextStyle style
    Field Value
    Type Description
    TextStyle

    textAlign

    Declaration
    public readonly TextAlign textAlign
    Field Value
    Type Description
    TextAlign

    textCapitalization

    Declaration
    public readonly TextCapitalization textCapitalization
    Field Value
    Type Description
    TextCapitalization

    textDirection

    Declaration
    public readonly TextDirection textDirection
    Field Value
    Type Description
    TextDirection

    textInputAction

    Declaration
    public readonly TextInputAction? textInputAction
    Field Value
    Type Description
    Nullable<TextInputAction>

    Properties

    selectionEnabled

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

    Methods

    createState()

    Declaration
    public override State createState()
    Returns
    Type Description
    State
    Overrides
    StatefulWidget.createState()

    debugFillProperties(DiagnosticPropertiesBuilder)

    Declaration
    public override void debugFillProperties(DiagnosticPropertiesBuilder properties)
    Parameters
    Type Name Description
    DiagnosticPropertiesBuilder properties
    Overrides
    Widget.debugFillProperties(DiagnosticPropertiesBuilder)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023