WoW:API SimpleHTML SetText: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (→‎Also See: corrected Link)
m (Move page script moved page API SimpleHTML SetText to API SimpleHTML SetText without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{widgetmethod}} __NOTOC__
{{widgetmethod|SimpleHtml}}
 
This method will set the SimpleHTML text content to the supplied text.
This method will set the SimpleHTML text content to the supplied text.


  SimpleHTML:SetText("arg1");
  SimpleHTML:SetText("arg1");


== Parameters ==
== Parameters ==
Line 10: Line 8:
:("arg1")
:("arg1")


:;arg1 : String - Text that will be displayed in the SimpleHTML element.
:;arg1
:: String - Text that will be displayed in the SimpleHTML element.


=== Returns ===
=== Returns ===
:;nil : nil - Will always return nil.
:;nil
 
:: nil - Will always return nil.


==Details==
== Details ==
The SimpleHTML element supports (as hinted by the name) a simple HTML-like markup. It also supports normal plain text with standard escape sequences. If the string does not contain the "<HTML><BODY>...</BODY></HTML>" structure (with only whitespace before the "<HTML>" tag) it will automagically revert to plain mode.
The SimpleHTML element supports (as hinted by the name) a simple HTML-like markup. It also supports normal plain text with standard escape sequences. If the string does not contain the "<HTML><BODY>...</BODY></HTML>" structure (with only whitespace before the "<HTML>" tag) it will automagically revert to plain mode.


See [[UIOBJECT_SimpleHTML]] for supported markup.
See [[UIOBJECT SimpleHTML]] for supported markup.


== See Also ==
* [[UI Escape Sequences]]


==Also See==
* [[UI Escape Sequences]]
<!-- I plan to create a wikipage about that one so information is centralized an *correct*! So please dont remove this link, just alter to a more fitting name if you like so -->
* [[UIOBJECT_SimpleHTML]]
* [[UISUMMARY SimpleHTML|SimpleHTML summary]]
<!--
<!--
I'm keeping this one just to not delete information that can be important later.
I'm keeping this one just to not delete information that can be important later.

Latest revision as of 04:47, 15 August 2023

Widget API ← SimpleHTML < SetText

This method will set the SimpleHTML text content to the supplied text.

SimpleHTML:SetText("arg1");

Parameters[edit]

Arguments[edit]

("arg1")
arg1
String - Text that will be displayed in the SimpleHTML element.

Returns[edit]

nil
nil - Will always return nil.

Details[edit]

The SimpleHTML element supports (as hinted by the name) a simple HTML-like markup. It also supports normal plain text with standard escape sequences. If the string does not contain the "<HTML><BODY>...</BODY></HTML>" structure (with only whitespace before the "<HTML>" tag) it will automagically revert to plain mode.

See UIOBJECT SimpleHTML for supported markup.

See Also[edit]