View comments | RSS feed
Contents > CFML Reference > ColdFusion Functions > HTMLEditFormat PreviousNext

HTMLEditFormat

Replaces special characters in a string with their HTML-escaped equivalents.

HTML-escaped string string. Returns are removed from string. Special characters (for example, < " &) are escaped.

Display and formatting functions

HTMLEditFormat(string [, version ])

HTMLCodeFormat

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

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.

<!--- 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>

Contents > CFML Reference > ColdFusion Functions > HTMLEditFormat PreviousNext

ColdFusion 8 | ColdFusion MX 7 | ColdFusion MX 6.1 | ColdFusion MX | Forums | Developer Center | Bug Reporting

Version 6.1

Comments are no longer accepted for ColdFusion MX 6.1. ColdFusion 8 is the current version.

Comments


lhoess said on May 18, 2004 at 4:19 PM :
The version is not working with the HTMLCodeFormat.
I tried htmleditformat(temp), 'HTML 3.2')
htmleditformat(temp), '3.2')
htmleditformat(temp), '2.0')
without success.
simeonhristov_23 said on Jan 28, 2005 at 11:50 AM :
How about processing single quotes, huh? This function is useless,
rubbish!
.jeff said on Mar 4, 2005 at 5:11 PM :
So write your own UDF that escapes the characters <strong>you</strong> want it to escape. That's the power of CF.

As single-quotes aren't considered special characters, I fail to see the reason to replace them. Moreover, we didn't even have an appropriate HTML character entity reference until XHTML 1.0. The only possible reason I could see is if you're using single quotes as attribute qualifiers in your (X)HTML in which case you should probably seriously reconsider that as best practice dictates that you use double-quotes, for a myriad of reasons.
No screen name said on Mar 17, 2005 at 11:04 AM :
.jeff - there are many reasons when utilizing coldfusion and javascript to need to escape the single quotes.
lther said on Apr 19, 2005 at 1:22 PM :
I love this feature... just came in SO handy (trying to edit something with double-quotes in the form field). I didn't use a version numer though...
hereticmessiah said on Jul 22, 2005 at 11:52 AM :
@ No screen name: But that's what JSStringFormat() is for. Both HTML and JS escape their special characters in different ways. It wouldn't pay--in fact, it'd be harmful--to conflate the two.
alex@inspiracio.com said on Sep 6, 2006 at 4:36 AM :
This is what HTMLEditFormat(s) does:
It substitutes the following fives chars with theses strings.
13 (CR) -> (empty String)
34 " -> &quot;
38 & -> &amp;
60 < -> &lt;
62 < -> &gt;
No screen name said on Sep 7, 2006 at 5:17 AM :
This script, which you could write to a function (its currently a custom tag) allows you to convert any values you wish to an ASCII version that HTML browsers can read. This will cover the question about single quotes where as the current HTMLEditFormat function does not allow that.

<cfSilent>

<cfParam name="attributes.value" default="">
<cfParam name="attributes.convert" default=""" < >">

<cfLoop list="#attributes.convert#" index="iConvert" delimiters=" ">
<cfSet attributes.value = Replace(attributes.value,iConvert,"&###ASC(iConvert)#;","all")>
</cfLoop>

</cfSilent><cfOutput>#attributes.value#</cfOutput>

 

RSS feed | Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/coldfusion/6.1/htmldocs/funct116.htm