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

    Class EditableText

    Inheritance
    Object
    Diagnosticable
    DiagnosticableTree
    CanonicalMixinDiagnosticableTree
    Widget
    StatefulWidget
    EditableText
    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.widgets
    Syntax
    public class EditableText : StatefulWidget

    Constructors

    EditableText(TextEditingController, FocusNode, TextStyle, StrutStyle, Color, Color, Boolean, Boolean, TextAlign, Nullable<TextDirection>, Nullable<Single>, Nullable<Int32>, Nullable<Int32>, Boolean, Boolean, Color, TextSelectionControls, TextInputType, Nullable<TextInputAction>, TextCapitalization, ValueChanged<String>, VoidCallback, ValueChanged<String>, SelectionChangedCallback, List<TextInputFormatter>, Boolean, EdgeInsets, Boolean, Key, Nullable<Single>, Radius, Boolean, Offset, Boolean, Nullable<Brightness>, DragStartBehavior, Nullable<Boolean>, ScrollPhysics, GlobalKeyEventHandlerDelegate)

    Declaration
    public EditableText(TextEditingController controller = null, FocusNode focusNode = null, TextStyle style = null, StrutStyle strutStyle = null, Color cursorColor = null, Color backgroundCursorColor = null, bool obscureText = false, bool autocorrect = false, TextAlign textAlign = TextAlign.left, TextDirection? textDirection = default(TextDirection? ), float? textScaleFactor = default(float? ), int? maxLines, int? minLines = default(int? ), bool expands = false, bool autofocus = false, Color selectionColor = null, TextSelectionControls selectionControls = null, TextInputType keyboardType = null, TextInputAction? textInputAction = default(TextInputAction? ), TextCapitalization textCapitalization = TextCapitalization.none, ValueChanged<string> onChanged = null, VoidCallback onEditingComplete = null, ValueChanged<string> onSubmitted = null, SelectionChangedCallback onSelectionChanged = null, List<TextInputFormatter> inputFormatters = null, bool rendererIgnoresPointer = false, EdgeInsets scrollPadding = null, bool unityTouchKeyboard = false, Key key = null, float? cursorWidth, Radius cursorRadius = null, bool cursorOpacityAnimates = false, Offset cursorOffset = null, bool paintCursorAboveText = false, Brightness? keyboardAppearance, DragStartBehavior dragStartBehavior = DragStartBehavior.down, bool? enableInteractiveSelection = default(bool? ), ScrollPhysics scrollPhysics = null, GlobalKeyEventHandlerDelegate globalKeyEventHandler = null)
    Parameters
    Type Name Description
    TextEditingController controller
    FocusNode focusNode
    TextStyle style
    StrutStyle strutStyle
    Color cursorColor
    Color backgroundCursorColor
    Boolean obscureText
    Boolean autocorrect
    TextAlign textAlign
    Nullable<TextDirection> textDirection
    Nullable<Single> textScaleFactor
    Nullable<Int32> maxLines
    Nullable<Int32> minLines
    Boolean expands
    Boolean autofocus
    Color selectionColor
    TextSelectionControls selectionControls
    TextInputType keyboardType
    Nullable<TextInputAction> textInputAction
    TextCapitalization textCapitalization
    ValueChanged<String> onChanged
    VoidCallback onEditingComplete
    ValueChanged<String> onSubmitted
    SelectionChangedCallback onSelectionChanged
    List<TextInputFormatter> inputFormatters
    Boolean rendererIgnoresPointer
    EdgeInsets scrollPadding
    Boolean unityTouchKeyboard
    Key key
    Nullable<Single> cursorWidth
    Radius cursorRadius
    Boolean cursorOpacityAnimates
    Offset cursorOffset
    Boolean paintCursorAboveText
    Nullable<Brightness> keyboardAppearance
    DragStartBehavior dragStartBehavior
    Nullable<Boolean> enableInteractiveSelection
    ScrollPhysics scrollPhysics
    GlobalKeyEventHandlerDelegate globalKeyEventHandler

    Fields

    autocorrect

    Declaration
    public readonly bool autocorrect
    Field Value
    Type Description
    Boolean

    autofocus

    Declaration
    public readonly bool autofocus
    Field Value
    Type Description
    Boolean

    backgroundCursorColor

    Declaration
    public readonly Color backgroundCursorColor
    Field Value
    Type Description
    Color

    controller

    Declaration
    public readonly TextEditingController controller
    Field Value
    Type Description
    TextEditingController

    cursorColor

    Declaration
    public readonly Color cursorColor
    Field Value
    Type Description
    Color

    cursorOffset

    Declaration
    public readonly Offset cursorOffset
    Field Value
    Type Description
    Offset

    cursorOpacityAnimates

    Declaration
    public readonly bool cursorOpacityAnimates
    Field Value
    Type Description
    Boolean

    cursorRadius

    Declaration
    public readonly Radius cursorRadius
    Field Value
    Type Description
    Radius

    cursorWidth

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

    debugDeterministicCursor

    Declaration
    public static bool debugDeterministicCursor
    Field Value
    Type Description
    Boolean

    dragStartBehavior

    Declaration
    public readonly DragStartBehavior dragStartBehavior
    Field Value
    Type Description
    DragStartBehavior

    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

    globalKeyEventHandler

    Declaration
    public readonly GlobalKeyEventHandlerDelegate globalKeyEventHandler
    Field Value
    Type Description
    GlobalKeyEventHandlerDelegate

    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

    maxLines

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

    minLines

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

    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

    onSelectionChanged

    Declaration
    public readonly SelectionChangedCallback onSelectionChanged
    Field Value
    Type Description
    SelectionChangedCallback

    onSubmitted

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

    paintCursorAboveText

    Declaration
    public readonly bool paintCursorAboveText
    Field Value
    Type Description
    Boolean

    rendererIgnoresPointer

    Declaration
    public readonly bool rendererIgnoresPointer
    Field Value
    Type Description
    Boolean

    scrollPadding

    Declaration
    public readonly EdgeInsets scrollPadding
    Field Value
    Type Description
    EdgeInsets

    scrollPhysics

    Declaration
    public readonly ScrollPhysics scrollPhysics
    Field Value
    Type Description
    ScrollPhysics

    selectionColor

    Declaration
    public readonly Color selectionColor
    Field Value
    Type Description
    Color

    selectionControls

    Declaration
    public readonly TextSelectionControls selectionControls
    Field Value
    Type Description
    TextSelectionControls

    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
    Nullable<TextDirection>

    textInputAction

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

    textScaleFactor

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

    unityTouchKeyboard

    Declaration
    public readonly bool unityTouchKeyboard
    Field Value
    Type Description
    Boolean

    Properties

    selectionEnabled

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

    strutStyle

    Declaration
    public StrutStyle strutStyle { get; }
    Property Value
    Type Description
    StrutStyle

    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