Your Rating: Results: PatheticBadOKGoodOutstanding! 7 rates

Description

Encodes the input string for use in HTML attribute, such as table width or image height.

Returns

Encoded string

Category

Display and formatting functions

Syntax

encodeForHTMLAttribute(inputString [,canonicalize])

History

ColdFusion 10: Added this function.

Parameters

 

Parameter

Description

inputString

Required. The string to encode.

canonicalize

Optional. If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded. The default value for canonicalize is false. When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed. To use any other combinations you should canonicalize using canonicalize method and then do encoding.

 

Example

Labels
  • None
  1. Aug 20, 2014

    The "History" section needs to be updated. In CF10, this method accepted an argument called "strict" (see https://wikidocs.adobe.com/wiki/download/attachments/142214062/ColdFusion_CFMLReference.pdf).

    In CF11, the "strict" argument was removed, and a new one added called "canonicalize." While this may seem insignificant, it's most definitely not!

    In CF10, all inputStrings are always canonicalized, and as of CF11, they're optionally canonicalized (which is my preference, actually). So be warned!

    Sure would be nice if an update for CF10 would include this change to harmonize the method's intended behavior.


Searching ColdFusion, English documentation