View Helpers Miscellaneous Functions string controller
Returns formatted text using HTML break tags () based on the newline characters and carriage returns in the text that is passed in.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| text | string | Yes | The text to format. | |
| wrap | boolean | No | true | Set to true to wrap the result in a paragraph HTML element. |
| encode | boolean | No | true | Use this argument to decide whether the output of the function should be encoded in order to prevent Cross Site Scripting (XSS) attacks. Set it to true to encode all relevant output for the specific HTML element in question (e.g. tag content, attribute values, and URLs). For HTML elements that have both tag content and attribute values you can set this argument to attributes to only encode attribute values and not tag content. |
<!--- How most of your calls will look. --->
#simpleFormat(post.bodyText)#
<!--- Demonstrates what output looks like with specific data. --->
<cfsavecontent variable="comment">
I love this post!
Here's why:
* Short
* Succinct
* Awesome
</cfsavecontent>
#simpleFormat(comment)#
<!---
<p>I love this post!</p>
<p>Here's why:<br>
* Short<br>
* Succinct<br>
* Awesome</p>
--->