User Interface

User Interface (UI) refers to the visual and interactive elements of a digital system or application that enable users to interact with and control it.

About the component


Image Description
  •  Last Update 25 Oct, 2023
  •  Component Version : 6.0.0
  •  API 21, Android 5.0 Lollipop
  •  45 Blocks Available

Text Box

This component provides a text input field with extensive customization options for appearance and behavior.

Overview

The Textbox component is a versatile UI element designed for text input. It offers a wide array of properties to tailor its appearance and behavior, making it suitable for various input scenarios, from simple text fields to password inputs and multi-line text areas.

Events

Image Description
Events

AfterTextChanged()

  • Raised after the text is changed.

    • Image Description
    Events

    BeforeTextChanged(String text, int start, int count, int after)

  • Raised before the text is changed.

    • # Name Type(s) Default Value
    1 text text -
    2 start Integer -
    3 count Integer -
    4 after text -
    Image Description
    Events

    GotFocus()

  • Raised when the text box gains focus.

    • Image Description
    Events

    LostFocus()

  • Raised when the text box loses focus.

    • Image Description
    Events

    OnTextChanged(String text, int start, int before, int count)

  • Raised when the text is changed.

    • # Name Type(s) Default Value
    1 text text -
    2 start Integer -
    3 before text -
    4 count Integer -

    Methods

    Image Description
    Methods

    HideKeyboard()

  • Hides the software keyboard.

    • Image Description
    Methods

    RequestFocus()

  • Sets the text box as the active input field.

    • Image Description
    Methods

    SelectAllText()

  • Selects all the text in the textbox.

    • Image Description
    Methods

    SelectText(int start, int end)

  • Selects the text within the specified range.

    • # Name Type(s) Default Value
    1 start Integer -
    2 end Integer -
    Image Description
    Methods

    SetCursorPosition(int position)

  • Sets the cursor position to the specified index.

    • # Name Type(s) Default Value
    1 Position Integer -
    Image Description
    Image Description
    Methods

    SetCursorPositionAtEnd(), SetCursorPositionAtStart()

  • Sets the cursor position at the start of the text box.


  • Sets the cursor position at the end of the text box.

    • Image Description
    Methods

    SetMargin()

  • The space outside a component, between the component’s boundary and other components. It determines the distance between different UI elements.

    • # Name Type(s) Default Value
    1 left Integer 0
    2 right Integer 0
    3 top Integer 0
    4 bottom Integer 0
    Image Description
    Methods

    SetPadding()

  • The padding around the check box. Padding is the space inside the border.

    • # Name Type(s) Default Value
    1 left Integer 0
    2 right Integer 0
    3 top Integer 0
    4 bottom Integer 0
    Image Description
    Methods

    ShowErrorMessage(boolean enabled)

  • Shows or hides the error message.

    • # Name Type(s) Default Value
    1 enabled boolean -

    Properties

    Image Description
    Methods

    AllCaps

  • Determines if the text is displayed in all capital letters.

    • # Name Type(s) Default Value
    1 set allCaps boolean -
    Image Description
    Image Description
    Methods

    BackgroundColor

  • Sets the background color of the text box.

    • # Name Type(s) Default Value
    1 get BackgroundColor color #00000000
    2 set BackgroundColor color -
    Image Description
    Methods

    BreakStrategy

  • Sets the strategy used for breaking lines of text. Values: "Simple", "High Quality", "Balanced".

    • # Name Type(s) Default Value
    1 set BreakStrategy text -
    Image Description
    Methods

    CursorColor

  • Sets the color of the text box's cursor.

    • # Name Type(s) Default Value
    1 set CursorColor color -
    Image Description
    Methods

    CursorVisible

  • Determines if the text box's cursor is visible.

    • # Name Type(s) Default Value
    1 set cursorVisible boolean -
    Image Description
    Methods

    Ellipsize

  • Sets how text is truncated when it overflows the text box. Values: "End", "Marquee", "Middle", "Start", "None".

    • # Name Type(s) Default Value
    1 set Ellipsize Integer -
    Image Description
    Image Description
    Methods

    Enabled

  • Determines if the text box is enabled for user input.


    • # Name Type(s) Default Value
    1 get Enabled boolean true
    2 set Enabled boolean -
    Image Description
    Methods

    ErrorIcon

  • Sets the error icon that is shown with the error text.

    • # Name Type(s) Default Value
    1 set erroricon text -
    Image Description
    Image Description
    Methods

    ErrorText

  • Sets the error text that is shown below the textbox.


    • # Name Type(s) Default Value
    1 get ErrorText text -
    2 set ErrorText text -
    Image Description
    Image Description
    Methods

    FontSize

  • Sets the font size of the text.


    • # Name Type(s) Default Value
    1 get FontSize Integer 14.0
    2 set FontSize Integer 0
    Image Description
    Methods

    FreezesText

  • Determines if the text box saves its contents when frozen.

    • # Name Type(s) Default Value
    1 set FreezeText boolean false
    Image Description
    Methods

    Gravity

  • Sets the alignment of the text within the text box. Values: "Start", "Center", "End", "Bottom", "Top", "Left", "Right", "Fill", "Center Horizontal", "Center Vertical", "Clip Horizontal", "Clip Vertical", "Fill horizontal", "Fill Vertical".

    • # Name Type(s) Default Value
    1 set Gravity text start
    Image Description
    Image Description
    Methods

    Height

  • Returns the height of the text box in pixel value.


    • # Name Type(s) Default Value
    1 get height Integer -1
    2 set Height Integer -
    Image Description
    Image Description
    Methods

    Width

  • Returns the width of the text box in pixel value .


    • # Name Type(s) Default Value
    1 get Width Integer -
    2 set Width Integer -
    Image Description
    Image Description
    Methods

    HeightPercent, WidthPercent

  • Getter and Setter method for the Width/height of the textbox in percent value.


    • # Name Type(s) Default Value
    1 set heightPercent Integer -
    2 set WidthPercent Integer -
    Image Description
    Methods

    HighlightColor

  • Sets the highlight color of selected text.

    • # Name Type(s) Default Value
    1 set HeightlightColor color 0
    Image Description
    Image Description
    Methods

    Hint

  • Sets the hint text that is displayed when the text box is empty.


    • -
    # Name Type(s) Default Value
    1 get Hint text -
    2 set Hint text -
    Image Description
    Image Description
    Methods

    HintColor

  • Sets the color of the hint text.


    • # Name Type(s) Default Value
    1 get HintColor color -
    2 set HintColor color -
    Image Description
    Methods

    HorizontallyScrolling

  • Determines if the text box allows horizontal scrolling.

    • # Name Type(s) Default Value
    1 set HorizontallyScrolling boolean 0
    Image Description
    Methods

    HyphenationFrequency

  • Sets the frequency of hyphenation in the text. Values: "None", "Normal", "Full", "Normal Fast", "Full Fast".

    • # Name Type(s) Default Value
    1 set HyphenationFrequency text -
    Image Description
    Methods

    IncludeFontPadding

  • Determines if the text box includes extra padding for font ascenders and descenders.

    • # Name Type(s) Default Value
    1 set IncludeFontPadding Integer -
    Image Description
    Image Description
    Methods

    InputType

  • Sets the input type of the text box. Values: "Normal","Number","Text","Phone","Date Time","Number Password","Text Password","Decimal Number","Person Name","Postal Code","Email Address","URI","Visible Password","Web EditText","Web Email Address","Web Password"


    • # Name Type(s) Default Value
    1 get InputType text -
    2 set InputType text -
    Image Description
    Methods

    LastBaselineToBottomheight

  • Sets the distance from the bottom of the text box to the last text baseline.

    • # Name Type(s) Default Value
    1 set LastBaseLinetoBottomHeight Integer -
    Image Description
    Methods

    LetterSpacing

  • Sets the spacing between characters in the text.

    • # Name Type(s) Default Value
    1 set letterSpacing Integer -
    Image Description
    Methods

    LineHeight

  • Sets the explicit height between lines of text.

    • # Name Type(s) Default Value
    1 set LineHeight Integer -
    Image Description
    Methods

    LinkTextColor

  • Sets the color of links within the text.

    • # Name Type(s) Default Value
    1 set LinkTextColor color -
    Image Description
    Methods

    LinksClickable

  • Determines if links within the text are clickable.

    • # Name Type(s) Default Value
    1 set LinksClickable boolean true
    Image Description
    Methods

    MarqueeRepeatLimit

  • Sets the number of times the marquee animation repeats.

    • # Name Type(s) Default Value
    1 set marqueeRepeatLimit Integer 100
    Image Description
    Image Description
    Methods

    MaxLength

  • Sets the maximum number of characters that can be entered.


    • # Name Type(s) Default Value
    1 get maxLength Integer 0
    2 set maxLength Integer 0
    Image Description
    Image Description
    Methods

    MultiLine

  • Sets if the textbox will accept multiline input.


    • # Name Type(s) Default Value
    1 get MultiLine boolean false
    2 set ItemMenuRadius boolean -
    Image Description
    Image Description
    Methods

    ReadOnly

  • Sets if the textbox is read only.


    • # Name Type(s) Default Value
    1 get ReadOnly boolean false
    2 set ReadOnly boolean -
    Image Description
    Image Description
    Methods

    Text

  • Sets or gets the text content of the text box.


    • # Name Type(s) Default Value
    1 get Text text -
    2 set Text text -
    Image Description
    Image Description
    Methods

    TextColor

  • Sets the color of the text.

    • # Name Type(s) Default Value
    1 get TextColor color #00000000
    2 set TextColor color -
    Methods

    Visible

  • Returns the visibility of the text box whether it is true or false.

    • # Name Type(s) Default Value
    1 get Visible boolean true
    1 set Visible boolean -
    Image Description
    Image Description
    Methods

    Visible

  • Returns the visibility of the text box whether it is true or false.


  • set the visibility of the text box to true or false.

    • # Name Type(s) Default Value
    1 get Visible boolean true
    2 set Visible boolean -