parseText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "Samatra" to "Sa-Matra")
 
(104 intermediate revisions by 22 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|PARSETEXT]]
{{RV|type=command
[[Category:Scripting Commands OFP Elite |PARSETEXT]]
[[Category:Scripting Commands ArmA|PARSETEXT]]


|game1= ofpe
|version1= 1.00


|game2= arma1
|version2= 1.00


|game3= arma2
|version3= 1.00


<h2 style="color:#000066">''''' parseText ''''' ''text''</h2>
|game4= arma2oa
|version4= 1.50


|game5= tkoh
|version5= 1.00


'''Operand types:'''
|game6= arma3
|version6= 0.50


text: [[String]]
|gr1= Strings


'''Type of returned value:'''
|gr2= Structured Text


[[Structured Text]]
|descr= Creates a structured text by parsing the given XML description. Do not use [[parseText]] when displaying a localized text from [[Stringtable.xml]].<br>
A detailed explanation of all formatting possibilities can be found at [[Structured Text]].


'''Compatibility:'''
|s1= [[parseText]] text


Version 2.01 required.
|p1= text: [[String]]


'''Description:'''
|r1= [[Structured Text]]


Creates a structured text by parsing the given XML description.
|x1= <sqf>private _Stxt = parseText "First line<img image='data\isniper.paa'/><br/>Second line";</sqf>


|x2= <sqf>hintSilent parseText format["<t size='1.25' font='Zeppelin33' color='#ff0000'>%1 lives remaining.</t>", 12];</sqf>


'''Example:'''
|x3= <sqf>private _clickableLink = parseText "<a href='http://arma3.com'>A3</a>";</sqf>


txt = '''parseText''' "First line&lt;img image=data\isniper.paa/&gt;&ltbr/&gt;Second line"
|seealso= [[Structured Text]] [[composeText]] [[text]] [[localize]] [[ctrlSetStructuredText]]
}}
 
{{Note
|user= Dr_Eyeball
|timestamp= 20160901064700
|text= To convert a structured text back to a string type, just use:
<sqf>_str = str parseText _structuredText;</sqf>
}}
 
{{Note
|user= AgentRev
|timestamp= 20170901132300
|text= If you are parsing user-defined strings like player names, you may want to convert special characters to their {{Link|https://en.wikipedia.org/wiki/Character_encodings_in_HTML#XML_character_references|XML entities}} as a precaution beforehand, otherwise the result might be corrupted.
<sqf>
private _escapeXML =
{
_this
regexReplace ["&", "&amp;"]
regexReplace ["<", "&lt;"]
regexReplace [">", "&gt;"]
regexReplace ['"', "&quot;"]
regexReplace ["'", "&apos;"]
};
 
private _name = '<A&M> Paul "Bear" Bryant';
private _escapedName = _name call _escapeXML;
private _redName = parseText format ["<t color='#ff0000'>%1</t>", _escapedName];
</sqf>
}}
 
{{Note
|user= Sa-Matra
|timestamp= 20231013120233
|text= Here is a useful script snippet to safely use angled braces and ampersand in structured texts:
<sqf>_string regexReplace ["&", "&amp;"] regexReplace ["<", "&lt;"]</sqf>
}}

Latest revision as of 20:58, 4 July 2024

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Creates a structured text by parsing the given XML description. Do not use parseText when displaying a localized text from Stringtable.xml.
A detailed explanation of all formatting possibilities can be found at Structured Text.
Groups:
StringsStructured Text

Syntax

Syntax:
parseText text
Parameters:
text: String
Return Value:
Structured Text

Examples

Example 1:
private _Stxt = parseText "First line<img image='data\isniper.paa'/><br/>Second line";
Example 2:
hintSilent parseText format["<t size='1.25' font='Zeppelin33' color='#ff0000'>%1 lives remaining.</t>", 12];
Example 3:
private _clickableLink = parseText "<a href='http://arma3.com'>A3</a>";

Additional Information

See also:
Structured Text composeText text localize ctrlSetStructuredText

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Dr_Eyeball - c
Posted on Sep 01, 2016 - 06:47 (UTC)
To convert a structured text back to a string type, just use:
_str = str parseText _structuredText;
AgentRev - c
Posted on Sep 01, 2017 - 13:23 (UTC)
If you are parsing user-defined strings like player names, you may want to convert special characters to their XML entities as a precaution beforehand, otherwise the result might be corrupted.
private _escapeXML = { _this regexReplace ["&", "&amp;"] regexReplace ["<", "&lt;"] regexReplace [">", "&gt;"] regexReplace ['"', "&quot;"] regexReplace ["'", "&apos;"] }; private _name = '<A&M> Paul "Bear" Bryant'; private _escapedName = _name call _escapeXML; private _redName = parseText format ["<t color='#ff0000'>%1</t>", _escapedName];
Sa-Matra - c
Posted on Oct 13, 2023 - 12:02 (UTC)
Here is a useful script snippet to safely use angled braces and ampersand in structured texts:
_string regexReplace ["&", "&amp;"] regexReplace ["<", "&lt;"]
Retrieved from "https://community.bistudio.com/wiki?title=parseText&oldid=364995"