TextButton

TextButton : GuiButton

Overview

Properties

Bold

bool

Bold is a boolean property that determines whether the text rendered by the UI element is displayed in bold font style. When set to true, the text will appear bold, providing enhanced visibility or emphasis within the user interface. If set to false, the text will maintain its default font weight.

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui.TextButton

print(TextButton.Bold)

Text

string

Text determines the content displayed on the button

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui.TextButton

TextButton.Text = "Hello"

TextBounds

Vector2

TextBounds is determines the bounds of the text rendered by the UI element, representing the bounding rectangle for displayed text with dimensions indicated by its value.

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui.TextButton

print(TextButton.TextBounds)

TextColor3

Color3

TextColor3 represents a color property for text rendering in the UI element using RGB components.

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui.TextButton

TextButton.TextColor3 = Color3.new(255, 0, 0)

TextFits

bool

TextFits is a boolean property that indicates whether the rendered text content within a UI element fits within its allocated space.

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui.TextButton

print(TextButton.TextFits)

TextScaled

bool

TextScaled controls whether text in a UI element is scaled to fill the available space or its parent widget.

This scaling behavior can be determined by the TextScaled property, which allows for dynamic resizing of rendered text to fit within the UI element's space.

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui.TextButton

TextButton.TextScaled = true

TextSize

number

TextSize determines the font size of the text rendered by the UI element.

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui.TextButton

TextButton.TextSize = 50

TextTransparency

number

TextTransparency controls the transparency level of the text rendered by the UI element.

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui.TextButton

TextButton.TextTransparency = 0.5

TextWrapped

bool

TextWrapped is a boolean property that determines whether text in a UI element wraps to multiple lines within the GUI element space, potentially truncating excess text.

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui.TextButton

TextButton.TextWrapped = true

TextXAlignment

Enum.TextXAlignment

TextXAlignment determines the horizontal alignment of rendered text within a UI element.

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui.TextButton

print(TextButton.TextXAlignment)

TextYAlignment

Enum.TextYAlignment

TextYAlignment determines the vertical alignment of rendered text within a UI element.

Code Samples

local ScreenGui = script.Parent
local TextButton = ScreenGui.TextButton

print(TextButton.TextYAlignment)

Methods

Events