WoW:API EditBox SetText: Difference between revisions
Jump to navigation
Jump to search
(linkification, notoc and headings) |
m (Move page script moved page API EditBox SetText to API EditBox SetText without leaving a redirect) |
||
| (4 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{widgetmethod}} | {{widgetmethod}} | ||
__NOTOC__ | __NOTOC__ | ||
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 [[API EditBox GetText|EditBox:GetText()]] returns the empty string. | |||
Before {{battle-inline}} ''Battle for Azeroth'', unrenderable chars were displayed as '?'.{{fact|What does it do now?}} | |||
==Also | == See Also == | ||
[[UI Escape Sequences]] | * [[UIOBJECT EditBox|EditBox object]] | ||
* [[API EditBox GetText|EditBox:GetText()]] | |||
* [[API EditBox GetNumber|EditBox:GetNumber()]] | |||
* [[UI Escape Sequences]] | |||
Latest revision as of 04:45, 15 August 2023
← Widget API ← EditBox < SetText
Sets editBox's text to the specified string.
editBox:SetText(str)
Arguments[edit]
- str (string) -- the string you want to appear in the EditBox
Returns[edit]
- nil
Details[edit]
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 Template:Battle-inline Battle for Azeroth, unrenderable chars were displayed as '?'.[citation needed]