Class
GetTextBoundsParams
NotReplicated
Use with TextService:GetTextBoundsAsync() to measure the size of text.
Pass this instance to TextService:GetTextBoundsAsync() to measure the
size of text.
Properties 5#
FontDatatype.Font | The Font of the text being measured.ReadSafe |
RichTextboolean | Determines whether the measured text is interpreted using rich text markup.ReadSafe |
Sizefloat | The size of the text being measured.ReadSafe |
Textstring | The text being measured.ReadSafe |
Widthfloat | The width of the container for line breaking.ReadSafe |
Font: Datatype.Font#
ReadSafe
The Font of the text being measured. Corresponds to the
TextLabel.FontFace property on text objects.
Not to be confused with Font. This is an object that you can create
using Font.new().
RichText: boolean#
ReadSafe
Determines whether the text being measured is interpreted using
rich text markup. Corresponds to the
TextLabel.RichText property on text objects.
By default, the value is false, meaning the
GetTextBoundsParams.Text string is measured verbatim. When set to
true, rich text formatting tags in the string are parsed rather than
measured as literal characters, so the returned bounds reflect the styled
text.
Size: float#
ReadSafe
The size of the text that is being measured. Corresponds to the
TextLabel.TextSize property.
Text: string#
ReadSafe
The text being measured.
Width: float#
ReadSafe
The width of the container for line breaking. By default, the value is 0, which means no line breaking will be performed. You can set it to the width of the container that you'll be putting the text into.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild