WoW:API EditBox SetText: Difference between revisions

Revision as of 05:20, 8 September 2007

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

Sets editBox's text to the specified string.

editBox:SetText(str)

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

nil

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

@@ Line 1: / Line 1: @@
 {{widgetmethod}}
 __NOTOC__
-<center>'''SetText''' ''-Documentation by DerGhulbus-''</center>
- editBox:SetText(String)
+Sets editBox's text to the specified string.
-Sets the editBox's text to the specified string.
+ editBox:SetText(str)
-==Parameters==
-===Arguments===
-:("String")
+== Arguments ==
-:;String: the string you want to appear in the EditBox
+:'''str''' (string) -- the string you want to appear in the EditBox
-===Returns===
+== Returns ==
+:''nil''
-???
-==Details==
+== Details ==
 You should call a SetText("") every time you read from an EditBox, so the command line is free for the next input.
-==MultiLineEditBox==
+== See Also ==
-When using a MultiLineEditBox, there is a sub-control called Edit the actually contains the text.
+* [[UIOBJECT EditBox|EditBox object]]
-For example, if the form name is "TestFourForm" and the MultilineEditBox control name is $parentMultiEditBox then you would use '''TestFourFormMultiEditBoxEdit''' to put text into the control.
+* [[API EditBox GetText|EditBox:GetText()]]
+* [[API EditBox GetNumber|EditBox:GetNumber()]]
-<!-- begin code -->
+* [[UI Escape Sequences]]
- TestFourFormMultiEditBoxEdit:SetText("This is a test.");
-<!-- end code -->
-==Also See==
-[[UI Escape Sequences]]