<html>
<head>
<link href="mmres://user_interface_reference.css" rel="stylesheet" type="text/css">
<title>JSSTRINGFORMAT</title>
</head>
<body bgcolor="#FFFFFF" text="#000000">
   <div id="Description">
   <table cellpadding="0" cellspacing="0" border="0" width="100%" class="main">
      <tr> 
         <td valign="top" class="name">JSSTRINGFORMAT</td>
         <td valign="top" nowrap class="compatibility">&nbsp;</td>
      </tr>
      <tr>
         <td colspan="2" class="divider"><img src="dwres:18084" width="100%" height="1"></td>
      </tr>


    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">Description</span>
<p>
Escapes special JavaScript characters, such as single-quotation mark, double-quotation mark, and newline.
</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">Returns</span>
<p>
A string that is safe to use with JavaScript. 
</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">Category</span>
<p>
String functions
</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">Function syntax</span><pre>JSStringFormat(string)
</pre>    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">Parameters</span>
<p>

</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">Usage</span>
<p>
Escapes special JavaScript characters, so you can put arbitrary strings safely into JavaScript.
</p>
    </td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="CLEARSEPARATION">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" colspan="2" class="description"><span class="title">Example</span><pre>&lt;!--- This example shows the use of the JSStringFormat function. ----&gt;
&lt;h3&gt;JSStringFormat&lt;/h3&gt;
&lt;cfset stringValue = &quot;An example string value with a tab chr(8), 
a newline (chr10) and some &quot;&quot;quoted&quot;&quot; &#39;text&#39;&quot;&gt;

&lt;p&gt;This is the string we have created:&lt;br&gt;
&lt;cfoutput&gt;#stringValue#&lt;/cfoutput&gt;
&lt;/p&gt;
&lt;cfset jsStringValue = JSStringFormat(#stringValue#)&gt;
&lt;!----- Generate an alert from the JavaScript string jsStringValue. ----&gt;
&lt;SCRIPT&gt;
s = &quot;&lt;cfoutput&gt;#jsStringValue#&lt;/cfoutput&gt;&quot;;
alert(s); 
&lt;/SCRIPT&gt; 
</pre>
<p>

</p>

         </td>
      </tr>
   </table>
   </div>
<div id="STRING">
<table border="0" cellspacing="0" cellpadding="0" width="100%">
<tr>  
<td valign="top" class="name">STRING</td>
  <td valign="top" nowrap class="compatibility">&nbsp;</td>
  </tr>
  <tr>
  <td colspan="2" class="divider"><img src="dwres:18084" width="100%" height="1"></td>
  </tr>


<p>A string or a variable that contains one.</p>

  </td>
  </tr>
  </table>
</div>

  </body>
</html>
