Whatever message this page gives is out now! Go check it out!
HTMLCodeFormat
Last update:
May 18, 2026
Description
Replaces special characters in a string with their HTML-escaped equivalents and inserts <pre> and </pre> tags at the beginning and end of the string.
Returns
HTML-escaped string string, enclosed in <pre> and </pre> tags. Return characters are removed; line feed characters are preserved. Characters with special meanings in HTML are converted to HTML character entities such as >.
Category
Function syntax
HTMLCodeFormat(string [, version ])See also
Parameters
Parameter | Description |
string | A string or a variable that contains one. |
version | HTML version to use; currently ignored.
|
Usage
This function converts the following characters to HTML character entities:
Text character | Encoding |
< | < |
> | > |
& | & |
" | " |
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 HTMLEditFormat is that HTMLEditFormat does not surround 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>
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Share additional feedback to help us improve.
0/255
|
