TextBox

Determines whether clicking on the TextBox will clear its TextBox.Text property

This property provides a copy of Text that contains exactly what is being rendered by the TextBox. This is useful for eliminating style tags used for rich text markup; for example, when RichText is enabled, the ContentText property shows the text as it appears to the user.

This property determines the offset of the text cursor in bytes, or -1 if the TextBox is not currently being edited. A value of 1 represents the position before the first byte in the Text property. When used in conjunction with the SelectionStart property, it is possible to both get and set selected text within a TextBox.

Note that the units of this property are bytes and that many unicode characters such as emoji are longer than 1 byte. For instance, if a player types in "Hello👋" ("Hello" immediately followed by the waving hand sign), the cursor position would be 10, not 7, since the emoji uses 4 bytes.

This property selects one of several pre-defined Font fonts with which the UI element will render its text. Some fonts have bold, italic, and/or light variants.

This property is kept in sync with the TextBox.FontFace property. When setting Font, the FontFace property will be set to Datatype.Font.fromEnum(value).

This property is similar to the Font property but allows setting fonts that don't exist in Font.

This property is kept in sync with the TextBox.Font property. When setting FontFace, the Font property is set to the corresponding enum value, or to Font.Unknown if there are no matches.

This property determines the font size of a TextBox object.

Controls the height of lines, as a multiple of the font's em square size, by scaling the spacing between lines of text in the TextBox. Valid values range from 1.0 (default) to 3.0.

This property controls the maximum number of graphemes (or units of text) that are shown on the TextBox, regardless of whether it's showing the PlaceholderText or Text.

Changing the property does not change the position or size of the visible graphemes; the layout will be calculated as if all graphemes are visible.

Setting the property to -1 disables the limit and shows the entirety of the Text.

When set to true, text inside a TextBox is able to move onto multiple lines. This also enables players to use the Enter key to move onto a new line.

Comma-separated list of OpenType feature tags applied when the TextBox shapes and renders its text, such as zero for slashed zeros or ss03 for a stylistic set. Defaults to an empty string (no additional features).

Each entry uses standard OpenType feature-string syntax (for example, zero or ss03). Only a supported subset is applied; an unsupported feature, malformed string, or bracketed partial-enabling syntax (for example, zero[1:3]) is rejected, with the reason in OpenTypeFeaturesError.

Supports styling.

Read-only error, if any, from parsing and applying OpenTypeFeatures. Defaults to an empty string when the requested features applied successfully.

An error is produced when:

• The feature string is malformed and cannot be parsed.
• A requested feature is not in the supported set.
• A bracketed range syntax is used (partial feature enabling is not supported).

Sets the text color that gets used when no text has been entered into the TextBox.

Sets the text that gets displayed when no text has been entered into the TextBox.

This property determines whether the TextBox renders the Text string using rich text formatting. Rich text uses simple markup tags to style sections of the string in bold, italics, specific colors, and more.

Note that when the TextBox has this property enabled and the box gains focus, the player will be able to edit and interact with the complete XML string, including all of the formatting tags. When focus is lost, the text will automatically parse and render the tags as rich text.

Determines the starting position of a text selection, or -1 if the TextBox has no range of selected text. This property uses the same positioning logic as CursorPosition. SelectionStart will be greater than CursorPosition if the cursor is at the beginning of a selection, and less than CursorPosition if the cursor is at the end.

If set to true, input native to the platform is used instead of Roblox's built-in keyboard.

This property determines the text content rendered by the TextBox element. The visual properties of the string rendered to the screen is determined by TextColor3, TextTransparency, TextSize, FontFace, and other properties.

It is possible to render emoji such as 👋 and other symbols. These special symbols aren't affected by the TextColor3 property.

This property may contain newline characters, but it is not possible to type newline characters within the Properties window. Similarly, this property may contain a tab character, but it will render as a space instead.

This read-only property reflects the absolute size of rendered text in offsets. In other words, if you were to try to fit text into a rectangle, this property would reflect the minimum dimensions of the rectangle you would need in order to fit the text.

Using TextService:GetTextSize(), you can predict what TextBounds will be on a TextLabel given a string, Font, TextSize and frame size.

This property determines the color of non-placeholder text rendered by the TextBox. Text is rendered after the text stroke.

TextDirection in which the TextBox renders its text. Defaults to TextDirection.Auto, which picks direction from the text content so right-to-left scripts render right-to-left. TextDirection.LeftToRight and TextDirection.RightToLeft force left-to-right or right-to-left rendering.

Supports styling.

This property determines whether the player can change the Text through input. It is recommended to disable ClearTextOnFocus when this property is disabled, otherwise the text can be cleared on-focus.

Whether the text fits within the constraints of the TextBox.

This property determines whether text is scaled so that it fills the box's entire space. When enabled, TextSize is ignored and TextWrapped is automatically enabled. When this property is used for on-screen UI, it may be helpful to use a UITextSizeConstraint to restrict the range of possible text sizes.

See TextLabel.TextScaled for additional recommendations when using this property.

This property determines the height in offsets of one line of rendered text. The unit is in offsets, not points as in many document editing programs.

This property sets the color of the stroke (outline) of the rendered text. This property and TextStrokeTransparency determine the visual appearance of the text stroke.

This property sets the transparency of the stroke (outline) of the rendered text. This property and TextStrokeColor3 determine the visual appearance of the text stroke.

Since text stroke is simply multiple renderings of the same transparency, this property is essentially multiplicative on itself four times over; for example a TextStrokeTransparency of 0.5 appears about the same as TextTransparency of 0.0625, or 0.5^4.

This property determines the transparency of all the text rendered by the TextBox.

Controls the truncation of the text displayed in the TextBox.

When enabled, this property will render text on multiple lines within a TextBox element's space so that TextBounds will never exceed the GuiBase2d.AbsoluteSize of the element.

This is achieved by breaking long lines of text into multiple lines. Line breaks will prefer whitespace; should a long unbroken word exceed the width of the element, that word will be broken into multiple lines.

If further line breaks would cause the vertical height of the text (the Y component of TextBox.TextBounds) to exceed the vertical height of the element (the Y component of GuiBase2d.AbsoluteSize), then that line will not be rendered at all.

This property determines the horizontal alignment of text rendered within the TextBox element's space. It can be used in conjunction with TextYAlignment to fully determine text alignment on both axes.

This property does not affect the read-only properties TextBounds and TextFits.

This property determines the vertical alignment of text rendered within the TextBox element's space. It can be used in conjunction with TextXAlignment to fully determine text alignment on both axes.

This property does not affect the read-only properties TextBounds and TextFits.

Forces the client to focus on the TextBox.

Returns true if the TextBox is focused or false if it is not.

Forces the client to unfocus the TextBox. The submitted parameter lets you override the enterPressed parameter in the TextBox.FocusLost event.

This event fires when the TextBox gains focus, typically when a player clicks/taps on the TextBox to begin text entry. Also fires if TextBox focus is forced through CaptureFocus().

This event can be used alongside FocusLost to track when a TextBox both gains and loses focus.

This event fires when the TextBox loses its focus, typically when a player clicks/taps outside of it or presses Enter. Also fires if TextBox focus release is forced through ReleaseFocus().

This event can be used alongside FocusLost to track when a TextBox both gains and loses focus.

On mobile and console, this event fires when the TextBox is focused and the player presses the on-screen keyboard's return/enter button.