Widget API: FontString:SetText

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ Methods

← Widget API ← FontString < SetText

Synopsis

 FontString:SetText(string text)

Description

Sets the text to be displayed in the fontstring. The text will have the color given to it via the fontinstance definition (or a FontString:SetTextColor call). You may however use escape sequences to modify the string's appearance.

NOTE: FontString has a limit of ~4000 chars.

Examples

 FontString:SetText('|cff000000This text is black,|r |cffff0000while this text will be red.|r')

will return

 This text is black, while this text will be red.

---

Notes

• The Font must be set before calling this function. This is not done for you if the FontString is created via Frame:CreateFontString. There are 3 ways to ensure the Font is set:
  • Send in an inheritsFrom value to Frame:CreateFontString.
  • Set the inheritsFrom via FontInstance:SetFontObject.
  • Set the font directly via FontInstance:SetFont.