Roblox Wiki
Roblox Wiki
Roblox Wiki
36,964
pages
in: GUI classes, Classes added in 2009, Classes in memory category Gui,
and 2 more

TextBox

View source

A text entry box.

Properties

ClearTextOnFocus: bool

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/ClearTextOnFocus.
  • Category: Data.
  • Serialization: can save and load.
  • Thread safety: read safe

ContentText: string

  • Read-onlyThis property is capable of being read but not written.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/ContentText.
  • Category: Text.
  • Serialization: cannot load or save.
  • Thread safety: read safe

CursorPosition: int

This class member is missing documentation. Create or add to its subpage at Class:TextBox/CursorPosition.
  • Category: Data.
  • Serialization: cannot load or save.
  • Thread safety: read safe

Font: Font

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/Font.
  • Category: Text.
  • Serialization: can load only.
  • Thread safety: read safe

FontFace: Font

This class member is missing documentation. Create or add to its subpage at Class:TextBox/FontFace.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

FontSize: FontSize

  • Not replicatedThis member is not replicated across the network boundary.
  • DeprecatedThis member will be phased out and should be avoided while it is still available.
This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/FontSize.
  • Category: Text.
  • Serialization: can load only.
  • Thread safety: read safe

LineHeight: float

This class member is missing documentation. Create or add to its subpage at Class:TextBox/LineHeight.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

LocalizationMatchIdentifier: string

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/LocalizationMatchIdentifier.
  • Category: Text.
  • Read security: RobloxScriptSecurity.
  • Write security: RobloxScriptSecurity.
  • Serialization: can save and load.
  • Thread safety: read safe

LocalizationMatchedSourceText: string

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/LocalizationMatchedSourceText.
  • Category: Text.
  • Read security: RobloxScriptSecurity.
  • Write security: RobloxScriptSecurity.
  • Serialization: can save and load.
  • Thread safety: read safe

ManualFocusRelease: bool

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/ManualFocusRelease.
  • Category: Data.
  • Read security: RobloxScriptSecurity.
  • Write security: RobloxScriptSecurity.
  • Serialization: cannot load or save.
  • Thread safety: read safe

MaxVisibleGraphemes: int

This class member is missing documentation. Create or add to its subpage at Class:TextBox/MaxVisibleGraphemes.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

MultiLine: bool

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/MultiLine.
  • Category: Data.
  • Serialization: can save and load.
  • Thread safety: read safe

OpenTypeFeatures: string

This class member is missing documentation. Create or add to its subpage at Class:TextBox/OpenTypeFeatures.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

OpenTypeFeaturesError: string

  • Read-onlyThis property is capable of being read but not written.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/OpenTypeFeaturesError.
  • Category: Text.
  • Serialization: can save only.
  • Thread safety: read safe

OverlayNativeInput: bool

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/OverlayNativeInput.
  • Category: Data.
  • Read security: RobloxScriptSecurity.
  • Write security: RobloxScriptSecurity.
  • Serialization: cannot load or save.
  • Thread safety: read safe

PlaceholderColor3: Color3

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/PlaceholderColor3.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

PlaceholderText: string

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/PlaceholderText.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

ReturnKeyType: ReturnKeyType

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/ReturnKeyType.
  • Category: Data.
  • Read security: RobloxScriptSecurity.
  • Write security: RobloxScriptSecurity.
  • Serialization: cannot load or save.
  • Thread safety: read safe

RichText: bool

This class member is missing documentation. Create or add to its subpage at Class:TextBox/RichText.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

SelectionStart: int

This class member is missing documentation. Create or add to its subpage at Class:TextBox/SelectionStart.
  • Category: Data.
  • Serialization: cannot load or save.
  • Thread safety: read safe

ShouldEmitReturnEvents: bool

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/ShouldEmitReturnEvents.
  • Category: Data.
  • Read security: RobloxScriptSecurity.
  • Write security: RobloxScriptSecurity.
  • Serialization: cannot load or save.
  • Thread safety: read safe

ShouldEmitTabEvents: bool

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/ShouldEmitTabEvents.
  • Category: Data.
  • Read security: RobloxScriptSecurity.
  • Write security: RobloxScriptSecurity.
  • Serialization: cannot load or save.
  • Thread safety: read safe

ShouldEmitUpAndDownArrowEvents: bool

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/ShouldEmitUpAndDownArrowEvents.
  • Category: Data.
  • Read security: RobloxScriptSecurity.
  • Write security: RobloxScriptSecurity.
  • Serialization: cannot load or save.
  • Thread safety: read safe

ShowNativeInput: bool

This class member is missing documentation. Create or add to its subpage at Class:TextBox/ShowNativeInput.
  • Category: Data.
  • Serialization: can save and load.
  • Thread safety: read safe

Text: string

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/Text.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

TextBounds: Vector2

  • Read-onlyThis property is capable of being read but not written.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextBounds.
  • Category: Text.
  • Serialization: cannot load or save.
  • Thread safety: read safe

TextColor: BrickColor

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
  • DeprecatedThis member will be phased out and should be avoided while it is still available.
This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextColor.
  • Category: Text.
  • Serialization: can load only.
  • Thread safety: read safe

TextColor3: Color3

This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextColor3.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

TextDirection: TextDirection

This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextDirection.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

TextEditable: bool

This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextEditable.
  • Category: Data.
  • Serialization: can save and load.
  • Thread safety: read safe

TextFits: bool

  • Read-onlyThis property is capable of being read but not written.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextFits.
  • Category: Text.
  • Serialization: cannot load or save.
  • Thread safety: read safe

TextInputType: TextInputType

  • HiddenThis property is not shown in the object browser and properties window.
  • Not replicatedThis member is not replicated across the network boundary.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextInputType.
  • Category: Data.
  • Read security: RobloxScriptSecurity.
  • Write security: RobloxScriptSecurity.
  • Serialization: cannot load or save.
  • Thread safety: read safe

TextScaled: bool

This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextScaled.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

TextSize: float

This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextSize.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

TextStrokeColor3: Color3

This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextStrokeColor3.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

TextStrokeTransparency: float

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextStrokeTransparency.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

TextTransparency: float

This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextTransparency.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

TextTruncate: TextTruncate

This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextTruncate.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

TextWrap: bool

  • Not replicatedThis member is not replicated across the network boundary.
  • DeprecatedThis member will be phased out and should be avoided while it is still available.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextWrap.
  • Category: Text.
  • Serialization: can load only.
  • Thread safety: read safe

TextWrapped: bool

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextWrapped.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

TextXAlignment: TextXAlignment

This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextXAlignment.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

TextYAlignment: TextYAlignment

This class member is missing documentation. Create or add to its subpage at Class:TextBox/TextYAlignment.
  • Category: Text.
  • Serialization: can save and load.
  • Thread safety: read safe

Methods

CaptureFocus(): null

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/CaptureFocus.
  • Thread safety: unsafe

IsFocused(): bool

This class member is missing documentation. Create or add to its subpage at Class:TextBox/IsFocused.
  • Thread safety: unsafe

ReleaseFocus(submitted: bool = false): null

Parameters
NameTypeDefault
submittedboolfalse
  • Thread safety: unsafe

ResetKeyboardMode(): null

This class member is missing documentation. Create or add to its subpage at Class:TextBox/ResetKeyboardMode.
  • Security: RobloxScriptSecurity.
  • Thread safety: unsafe

SetTextFromInput(text: string): null

Parameters
NameType
textstring
  • Security: RobloxScriptSecurity.
  • Thread safety: unsafe

Events

FocusLost(enterPressed: bool, inputThatCausedFocusLoss: InputObject)

Parameters
NameType
enterPressedbool
inputThatCausedFocusLossInputObject
  • Thread safety: unsafe

Focused()

This API member has existing documentation in this page's Member list template.
This class member is missing documentation. Create or add to its subpage at Class:TextBox/Focused.
  • Thread safety: unsafe

ReturnPressedFromOnScreenKeyboard()

This class member is missing documentation. Create or add to its subpage at Class:TextBox/ReturnPressedFromOnScreenKeyboard.
  • Thread safety: unsafe

Removed members

Properties

  • Content
  • EnableRealtimeFilteringHints
  • IsPassword

External links[]

Community content is available under CC-BY-SA unless otherwise noted.