Widget API: EditBox: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 ← EditBox < SetText

Sets editBox's text to the specified string.

editBox:SetText(str)

Arguments

str (string) -- the string you want to appear in the EditBox

Returns

nil

Details

You should call a SetText("") every time you read from an EditBox, so the command line is free for the next input.

SetText fails when the text contains characters that aren't renderable (e.g. control chars, invalid UTF8). In that case the EditBox is cleared and EditBox:GetText() returns the empty string.

(Before WoW 8.0 unrenderable chars were displayed as '?')

See Also

• EditBox object
• EditBox:GetText()
• EditBox:GetNumber()
• UI Escape Sequences