WoW:API EditBox GetText: Difference between revisions

Latest revision as of 04:45, 15 August 2023

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 < GetText

Returns the text that is currently entered in the EditBox.

local text = editBox:GetText()

Parameters

Arguments

None

Returns

text (string) - the current text in the EditBox as a string

Details

Note that the special characters "|" and "\" are escaped in the returned string. That way GetText() returns "||" instead of "|" and "\\" instead of "\".

Comments

If you want to read in numbers you should use the GetNumber() function instead.

@@ Line 1: / Line 1: @@
-<center>'''GetText''' ''-Documentation by DerGhulbus-''</center>
+{{widgetmethod|toc=0}}
+Returns the text that is currently entered in the EditBox.
+ local text = editBox:GetText()
- str = editBox:GetText()
+== Parameters ==
+=== Arguments ===
+: None
-Returns the String that is currently entered in the EditBox.
+=== Returns ===
+* text (string) - the current text in the EditBox as a string
-----
+== Details ==
-;''Arguments''
+Note that the special characters "|" and "\" are escaped in the returned string. That way GetText() returns "||" instead of "|" and "\\" instead of "\".
-''???''
-----
-;''Returns''
-:str
-:;str: String - the current String in the EditBox
-----
-;''Details''
---
-----
-;''Comments''
+== Comments ==
 If you want to read in numbers you should use the [[API EditBox GetNumber|GetNumber()]] function instead.
-----
-{{Template:WoW API}}
-[[Category:API Functions|EditBox]]

Navigation menu

Search