User Guide

888 Chapter 3: ColdFusion Functions
ToScript
Description
Creates a JavaScript or ActionScript expression that assigns the value of a ColdFusion variable to a
JavaScript or ActionScript variable. This function can convert ColdFusion strings, numbers,
arrays, structures, and queries to JavaScript or ActionScript syntax that defines equivalent
variables and values.
Returns
A string that contains a JavaScript or ActionScript variable definition corresponding to the
specified ColdFusion variable value.
Category
Conversion functions, Extensibility functions
Function syntax
ToScript(cfvar, javascriptvar, outputformat, ASFormat)
See also
cfwddx;
Chapter 9, “WDDX JavaScript Objects,” in ColdFusion MX Developer’s Guide
History
ColdFusion MX 7: Added this function.
Parameters
Parameter Description
cfvar A ColdFusion variable. This can contain one of the following:
• String
• Number
• Array
• Structure
• Query
javascriptvar A string that specifies the name of the JavaScript variable that the
ToScript
function creates.
outputformat Optional. A Boolean value that determines whether to create WDDX (JavaScript)
or ActionScript style output for structures and queries:
• True: creates WDDX-style output (default).
• False: creates ActionScript-style output.
ASFormat Optional. A Boolean value that specifies whether to use ActionScript shortcuts in
the script:
• True: creates new Objects and Arrays with ActionScript shortcuts: [] for New
Array(), and {} for New Object. Using ActionScript shortcuts allows you to pass
ActionScript into
cfform attributes without triggering ActionScript validation.
• False: does not use ActionScript shortcuts to create new Objects and new Arrays
when generating the script. Instead, generates New Object() and New Array() in
the script (default).