User Guide

516 Chapter 3: ColdFusion Functions
HTMLEditFormat
Description
Replaces special characters in a string with their HTML-escaped equivalents.
Returns
HTML-escaped string string. Returns are removed from string. Special characters (for
example,
<"&) are escaped.
Category
Display and formatting functions
Function syntax
HTMLEditFormat(string [, version ])
See also
HTMLCodeFormat
Parameters
Usage
This function typically increases the length of a string. This can cause unpredictable results when
performing certain string functions (
Left, Right, and Mid, for example) against the expanded
string.
The only difference between this function and
HTMLCodeFormat is that HTMLCodeFormat
surrounds the text in an HTML
pre tag.
Example
<!--- This example shows the effects of HTMLCodeFormat and
HTMLEditFormat. View it in your browser, then View it
using your browser's the View Source command. --->
<cfset testString="This is a test
& this is another
<This text is in angle brackets>
Previous line was blank!!!">
<cfoutput>
<h3>The text without processing</h3>
#testString#<br>
<h3>Using HTMLCodeFormat</h3>
#HTMLCodeFormat(testString)#
<h3>Using HTMLEditFormat</h3>
#HTMLEditFormat(testString)#
</cfoutput>
Parameter Description
string A string or a variable that contains one.
version HTML version to use. currently ignored.
• -1: The latest implementation of HTML
• 2.0: HTML 2.0 (Default)
• 3.2: HTML 3.2