WoW:API EditBox HighlightText: 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

Highlights the text in an EditBox.

EditBox:HighlightText([start], [end])

Start: [Optional] Integer - the position at which to start the highlight and defaults to 0 if omitted.
End: [Optional] Integer - the position at which to stop the highlight and defaults to the end of the string if omitted.

The position before the first character is 0.

Leaving out both parameters, as in EditBox:HighlightText(), will highlight the entire EditBox content.

@@ Line 1: / Line 1: @@
 {{widgetmethod}}
-{{stub/api}}
-Highlights the text in a Textbox.
+Highlights the text in an EditBox.
-Params (start[, end])
+ EditBox:HighlightText([start], [end])
-Starts is the character to start highlighting at (0 => beginning), [end] is optional and defaults to the length.
-Thus:
-'''Editbox:HighlightText(0);'''
+== Parameters ==
+=== Arguments ===
-will highlight the whole EditBox Content.
+:;Start : [Optional] Integer - the position at which to start the highlight and defaults to 0 if omitted.
+:;End : [Optional] Integer - the position at which to stop the highlight and defaults to the end of the string if omitted.
+== Details ==
+The position before the first character is 0.
+Leaving out both parameters, as in '''EditBox:HighlightText()''', will highlight the entire EditBox content.