Reference API Roblox

Engine API

Website

Related

Reference API Roblox

TextBox

Summary

Member index 46

HistoryMember
553ClearTextOnFocus: bool
553ContentText: string
553CursorPosition: int
553FontFace: Font
553FontSize: FontSize
553LineHeight: float
553MaxVisibleGraphemes: int
553MultiLine: bool
553PlaceholderColor3: Color3
486PlaceholderText: string
553RichText: bool
553SelectionStart: int
553ShowNativeInput: bool
553Text: string
553TextBounds: Vector2
553TextColor3: Color3
581TextDirection: TextDirection
553TextEditable: bool
553TextFits: bool
553TextScaled: bool
553TextSize: float
553TextStrokeColor3: Color3
553TextStrokeTransparency: float
553TextTransparency: float
553TextTruncate: TextTruncate
553TextWrap: bool
553TextWrapped: bool
553TextXAlignment: TextXAlignment
553TextYAlignment: TextYAlignment
573CaptureFocus(): null
462IsFocused(): bool
573ReleaseFocus(submitted: bool = false): null
573ResetKeyboardMode(): null
573SetTextFromInput(text: string): null
483FocusLost(enterPressed: bool, inputThatCausedFocusLoss: InputObject)
462Focused()
462ReturnPressedFromOnScreenKeyboard()
inherited from GuiObject
553Active: bool
553AnchorPoint: Vector2
553AutomaticSize: AutomaticSize
553BackgroundColor3: Color3
553BackgroundTransparency: float
553BorderColor3: Color3
553BorderMode: BorderMode
553BorderSizePixel: int
553ClipsDescendants: bool
553Draggable: bool
588GuiState: GuiState
589Interactable: bool
553LayoutOrder: int
553NextSelectionDown: GuiObject
553NextSelectionLeft: GuiObject
553NextSelectionRight: GuiObject
553NextSelectionUp: GuiObject
553Position: UDim2
553Rotation: float
553Selectable: bool
553SelectionImageObject: GuiObject
553SelectionOrder: int
553Size: UDim2
553SizeConstraint: SizeConstraint
553Visible: bool
553ZIndex: int
462TweenPosition(endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462TweenSize(endSize: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462TweenSizeAndPosition(endSize: UDim2, endPosition: UDim2, easingDirection: EasingDirection = Out, easingStyle: EasingStyle = Quad, time: float = 1, override: bool = false, callback: Function = nil): bool
462DragBegin(initialPosition: UDim2)
462DragStopped(x: int, y: int)
483InputBegan(input: InputObject)
483InputChanged(input: InputObject)
483InputEnded(input: InputObject)
462MouseEnter(x: int, y: int)
462MouseLeave(x: int, y: int)
462MouseMoved(x: int, y: int)
462MouseWheelBackward(x: int, y: int)
462MouseWheelForward(x: int, y: int)
462SelectionGained()
462SelectionLost()
462TouchLongPress(touchPositions: Array, state: UserInputState)
462TouchPan(touchPositions: Array, totalTranslation: Vector2, velocity: Vector2, state: UserInputState)
462TouchPinch(touchPositions: Array, scale: float, velocity: float, state: UserInputState)
462TouchRotate(touchPositions: Array, rotation: float, velocity: float, state: UserInputState)
462TouchSwipe(swipeDirection: SwipeDirection, numberOfTouches: int)
462TouchTap(touchPositions: Array)
inherited from GuiBase2d
553AbsolutePosition: Vector2
553AbsoluteRotation: float
553AbsoluteSize: Vector2
553AutoLocalize: bool
553RootLocalizationTable: LocalizationTable
553SelectionBehaviorDown: SelectionBehavior
553SelectionBehaviorLeft: SelectionBehavior
553SelectionBehaviorRight: SelectionBehavior
553SelectionBehaviorUp: SelectionBehavior
553SelectionGroup: bool
525SelectionChanged(amISelected: bool, previousSelection: GuiObject, newSelection: GuiObject)
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

Removed member index 3

HistoryMember
466Content: string
402IsPassword: bool

History 202

Members 46

CaptureFocus

Parameters (0)
No parameters.
Returns (1)
null

History 4

ClearTextOnFocus

TypeDefault
booltrue

History 4

ContentText

TypeDefault
stringTextBox
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

CursorPosition

TypeDefault
int1

History 4

FocusLost

Parameters (2)
enterPressedbool
inputThatCausedFocusLossInputObject

History 4

Focused

Parameters (0)
No parameters.

History 2

FontFace

TypeDefault
Font

History 2

FontSize

TypeDefault
FontSizeSize8
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. TextSize should be used instead.
This property is not replicated. Its interface does not cross the network boundary.

History 6

Tags: [NotReplicated, Deprecated]

IsFocused

Parameters (0)
No parameters.
Returns (1)
bool

History 2

LineHeight

TypeDefault
float1

History 4

MaxVisibleGraphemes

TypeDefault
int-1

History 3

MultiLine

TypeDefault
boolfalse

History 4

PlaceholderColor3

TypeDefault
Color30.7, 0.7, 0.7

History 6

PlaceholderText

TypeDefault
string

History 5

ReleaseFocus

Parameters (1)Default
Returns (1)
null

History 4

ResetKeyboardMode

Parameters (0)
No parameters.
Returns (1)
null

History 3

ReturnPressedFromOnScreenKeyboard

Parameters (0)
No parameters.

History 2

RichText

TypeDefault
boolfalse

History 4

SelectionStart

TypeDefault
int-1

History 4

SetTextFromInput

Parameters (1)
textstring
Returns (1)
null

History 3

ShowNativeInput

TypeDefault
booltrue

History 4

Text

TypeDefault
stringTextBox

History 4

  • 553 Change Default of Text from to TextBox
  • 486 Change ThreadSafety of Text from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Text from to ReadOnly
  • 47 Add Text

TextBounds

TypeDefault
Vector20, 0
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

TextColor3

TypeDefault
Color30.105882, 0.164706, 0.207843

History 4

TextDirection

TypeDefault
TextDirectionAuto

History 1

TextEditable

TypeDefault
booltrue

History 4

TextFits

TypeDefault
boolfalse
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

TextScaled

TypeDefault
boolfalse

History 4

TextSize

TypeDefault
float8

History 4

TextStrokeColor3

TypeDefault
Color30, 0, 0

History 4

TextStrokeTransparency

TypeDefault
float1

History 4

TextTransparency

TypeDefault
float0

History 4

TextTruncate

TypeDefault
TextTruncateNone

History 4

TextWrap

TypeDefault
boolfalse
This property is deprecated. It exists only for backward compatibility, and should not be used for new work. TextWrapped should be used instead.
This property is not replicated. Its interface does not cross the network boundary.

History 6

Tags: [NotReplicated, Deprecated]

TextWrapped

TypeDefault
boolfalse

History 4

TextXAlignment

TypeDefault
TextXAlignmentCenter

History 4

TextYAlignment

TypeDefault
TextYAlignmentCenter

History 4

Removed members 3

Content

TypeDefault
string
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

IsPassword

TypeDefault
bool
This property is not replicated. Its interface does not cross the network boundary.

History 2

Tags: [NotReplicated]

Settings