MultilineTextField
Written by Hypixel Studios Canada Inc.
MultilineTextField
Accepts child elements: No
A multi-line text field which lets the user enter text with their keyboard
Properties
| Name | Type | Description |
|---|---|---|
| ScrollbarStyle | ScrollbarStyle | |
| Value | String | |
| Visible | Boolean | Hides the element. Makes the parent layouting skip this element as well |
| HitTestVisible | Boolean | By default, most elements won't return themselves during a HitTest check unless they expose certain functionality that requires them to (e.g. a button). This means that elements visually underneath them might receive the input event instead. If you want this element to be returned during a HitTest set this to true |
| TooltipText | String | Enables a text tooltip and sets the text to show. The tooltip will be shown while the mouse cursor is on this element |
| TooltipTextSpans | List<LabelSpan> | Enables a text tooltip and sets the text spans to show. The tooltip will be shown while the mouse cursor is on this element |
| TextTooltipStyle | TextTooltipStyle | Style options for the text tooltip |
| TextTooltipShowDelay | Float | Specifies a delay in seconds for long the mouse has to stay on this element for the tooltip to appear |
| Style | InputFieldStyle | Text style properties |
| PlaceholderStyle | InputFieldStyle | Text style properties for placeholder text |
| Decoration | InputFieldDecorationStyle | Field style properties |
| AutoFocus | Boolean | If true, the element will automatically set itself as the focused element when after being mounted. If there are other elements with this property enabled, the last of them to be mounted will gain focus. |
| AutoSelectAll | Boolean | Automatically selects all text after being mounted. This property won't work unless is enabled. |
| IsReadOnly | Boolean | Whether the value of this field can be edited or not |
| MaxLength | Integer | The maximum amount of characters that can be entered into this field |
| MaxLines | Integer | The maximum number of lines that can be entered in this field (0 for unlimited). |
| MaxVisibleLines | Integer | |
| AutoGrow | Boolean | Whether the input show grow for new lines or have a static height based on . Always enabled if MaxLines is not specified. |
| ContentPadding | Padding | |
| PlaceholderText | String | Text that will be displayed when the field is empty |
| Anchor | Anchor | Defines how the element should be laid out inside its allocated area |
| Padding | Padding | Defines how much space to keep around the content. Background is unaffected. |
| FlexWeight | Integer | FlexWeight can be used to distribute any left-over space after explicit widths/heights have been subtracted |
| ContentWidth | Integer | If set, this element will display a horizontal scrollbar |
| ContentHeight | Integer | If set, this element will display a vertical scrollbar |
| AutoScrollDown | Boolean | Makes the element automatically scroll down to the bottom of the element. The element won't try to scroll down if it has been scrolled up |
| KeepScrollPosition | Boolean | Whether to keep the scrolling position, even after the element has been unmounted |
| MouseWheelScrollBehaviour | MouseWheelScrollBehaviourType | |
| Background | PatchStyle / String | Sets a background image or color |
| MaskTexturePath | UI Path (String) | Sets a mask texture to be used for clipping. (Doesn't support 9-patches yet) |
| OutlineColor | Color | Sets the color for the outline to render |
| OutlineSize | Float | Draws a basic outline around the element with the specified size |
| Overscroll | Boolean | If enabled scrolling areas will be extended by the size of the element |
Event Callbacks
| Name | Description |
|---|---|
| Validating | Called when the enter key is being pressed while this element is focused |
| Dismissing | Called when the escape key is being pressed while this element is focused |
| Blurred | Called after this element loses focus |
| Focused | Called after this element gains focus |
| ValueChanged |