User Guide Cancel

cfscript

Last updated on May 30, 2024 | Also applies to ColdFusion

CFML Reference User Guide
ColdFusion functions
ColdFusion Tags
1. ColdFusion tag summary
2. ColdFusion tags by category
  1. Application framework tags
    1. cfapplication
    2. cfassociate
    3. cferror
    4. cfimport
    5. cfinterface
    6. cflock
    7. cfscript
    8. cfthread
  2. Communications tags
  3. Database manipulation tags
  4. Data output tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcol
    5. cfcontent
    6. cfdocument
    7. cfdocumentitem
    8. cfdocumentsection
    9. cfflush
    10. cfheader
    11. cflog
    12. cfoutput
    13. cfpresentation
    14. cfpresentationslide
    15. cfpresenter
    16. cfprocessingdirective
    17. cfprint
    18. cfreport
    19. cfreportparam
    20. cfsilent
    21. cftable
  5. Debugging tags
    1. cfdump
    2. cftimer
    3. cftrace
  6. Exception handling tags
    1. cfcatch
    2. cferror
    3. cffinally
    4. cfrethrow
    5. cfthrow
    6. cftry
  7. Extensibility tags
    1. cfchart
    2. cfchartdata
    3. cfchartseries
    4. cfcollection
    5. cfcomponent
    6. cfexecute
    7. cfftp
    8. function
    9. cfindex
    10. cfinterface
    11. cfinvoke
    12. cfinvokeargument
    13. cfobject
    14. cfproperty
    15. cfreport
    16. cfreportparam
    17. cfreturn
    18. cfsearch
    19. cfsharepoint
    20. cfspreadsheet
    21. cfwddx
    22. cfxml
  8. File management tags
    1. cfdirectory
    2. cffile
    3. cffileupload
    4. cfftp
    5. cfzip
    6. cfzipparam
  9. Flow-control tags
    1. cfabort
    2. cfbreak
    3. cfcase
    4. cfcontinue
    5. cfdefaultcase
    6. cfelse
    7. cfelseif
    8. cfexecute
    9. cfexit
    10. cfif
    11. cfinclude
    12. cflocation
    13. cfloop
    14. cfrethrow
    15. cfswitch
    16. cfthrow
    17. cftry
  10. Forms tags
    1. cfapplet
    2. cfcalendar
    3. cffileupload
    4. cfform
    5. cfformgroup
    6. cfformitem
    7. cfgrid
    8. cfgridcolumn
    9. cfgridrow
    10. cfgridupdate
    11. cfinput
    12. cfpdf
    13. cfpdfform
    14. cfpdfformparam
    15. cfpdfparam
    16. cfpdfsubform
    17. cfselect
    18. cfslider
    19. cftextarea
    20. cftree
    21. cftreeitem
  11. Internet Protocol tags
    1. cfajaximport
    2. cfajaxproxy
    3. cfftp
    4. cffeed
    5. cfimap
    6. cfhttp
    7. cfhttpparam
    8. cfldap
    9. cfmail
    10. cfmailparam
    11. cfmailpart
    12. cfpop
    13. cfsprydataset
  12. Page processing tags
    1. cfcache
    2. cfcontent
    3. cfflush
    4. cfheader
    5. cfhtmlhead
    6. cfinclude
    7. cfprocessingdirective
    8. cfsetting
    9. cfsilent
  13. Security tags
  14. Variable manipulation tags
    1. cfcookie
    2. cfdump
    3. cfparam
    4. cfregistry
    5. cfsavecontent
    6. cfschedule
    7. cfset
    8. cfsetting
  15. Other tags
    1. cfimage
    2. cflog
    3. cfregistry
3. Tags a-b
4. Tags c
  1. cfcache
  2. cfcalendar
  3. cfcase
  4. cfcatch
  5. cfchart
  6. cfchartdata
  7. cfchartseries
  8. cfclient
  9. cfclientsettings
  10. cfcol
  11. cfcollection
  12. cfcomponent
  13. cfcontent
  14. cfcontinue
  15. cfcookie
  16. Tags d-e
5. Tags f
6. Tags g-h
  1. cfgraph
  2. cfgraphdata
  3. cfgrid
  4. cfgridcolumn
  5. cfgridrow
  6. cfgridupdate
  7. cfheader
  8. cfhtmlhead
  9. cfhtmltopdf
  10. cfhtmltopdfitem
  11. cfhttp
  12. cfhttpparam
7. Tags i
  1. cfif
  2. cfimage
  3. cfimap
  4. cfimapfilter
  5. cfimpersonate
  6. cfimport
  7. cfinclude
  8. cfindex
  9. cfinput
  10. cfinsert
  11. cfinterface
  12. cfinvoke
  13. cfinvokeargument
8. Tags j-l
9. Tags m-o
10. Tags p-q
  1. cfparam
  2. cfpdf
  3. cfpdfform
  4. cfpdfformparam
  5. cfpdfparam
  6. cfpdfsubform
  7. cfpod
  8. cfpop
  9. cfpresentation
  10. cfpresentationslide
  11. cfpresenter
  12. cfprint
  13. cfprocessingdirective
  14. cfprocparam
  15. cfprocresult
  16. cfprogressbar
  17. cfproperty
  18. cfquery
  19. cfqueryparam
11. Tags r-s
  1. cfregistry
  2. cfreport
  3. cfreportparam
  4. cfrethrow
  5. cfreturn
  6. cfsavecontent
  7. cfschedule
  8. cfscript
  9. cfsearch
  10. cfselect
  11. cfservlet
  12. cfservletparam
  13. cfset
  14. cfsetting
  15. cfsharepoint
  16. cfsilent
  17. cfslider
  18. cfspreadsheet
  19. cfsprydataset
  20. cfstoredproc
  21. cfswitch
12. Tags t
  1. cftable
  2. cftextarea
  3. cftextinput
  4. cfthread
  5. cfthrow
  6. cftimer
  7. cftooltip
  8. cftrace
  9. cftransaction
  10. cftree
  11. cftreeitem
  12. cftry
13. Tags u-z
  1. cfupdate
  2. cfwddx
  3. cfwebsocket
  4. cfwindow
  5. cfxml
  6. cfzip
  7. cfzipparam
CFML Reference
1. Reserved words and variables
2. Ajax JavaScript functions
3. ColdFusion ActionScript functions
4. ColdFusion mobile functions
5. Application.cfc reference
6. Script functions implemented as CFCs
7. ColdFusion Flash Form style reference
8. ColdFusion event gateway reference
9. ColdFusion C++ CFX Reference
10. ColdFusion Java CFX reference
11. WDDX JavaScript Objects
Cloud services

The CFScript syntax provides a way of writing CFML code without using tags. CFScript can either be in a script based component (CFC) or inside the cfscript tag.

Description

Encloses a code block that contains cfscript statements.

Syntax

<cfscript> 
    // cfscript code here 
</cfscript>

History

ColdFusion 11: Enhanced support like usage of custom tags.

ColdFusion MX:

Changed how to invoke component methods: this tag can now invoke component methods, using the CreateObject function
Changed use of reserved words: you cannot use ColdFusion reserved words within this tag
Added the try and catch statements.

Usage

Performs processing in CFScript. This tag uses ColdFusion functions, expressions, and operators. You can read and write ColdFusion variables within this tag. For a detailed description of the CFScript scripting language, including documentation of CFScript statements and the CFScript equivalents of CFML tags, see Extending ColdFusion Pages with CFML Scripting in the Developing ColdFusion Applications.
You can use this tag to enclose a series of assignment statements that would otherwise require cfset statements.

Note:

If you code a cftry/cfcatch_ block within this tag using an exception's Java class name, provide the fullyqualified class name._

You cannot use some ColdFusion reserved words in this tag. You cannot put a user-defined function whose name begins with any of these strings within this tag:

cf
cf_
_cf
coldfusion
coldfusion_
_coldfusion
You cannot use the elseif construct within a cfscripttag. You can use code such as the following:

else if ( condition ) 
{ 
... 
}

Keywords

The following words are now treated as keywords:

import
finally
component
interface
pageencoding

For loop

<cfscript>
 myarr=[10,3,5,12,61];
 sum=0;
 for (i=1;i<=ArrayLen(myarr);i++){
  sum=sum+myarr[i];
 }
 writeoutput("The sum of the elements in the array is: " & sum);
</cfscript>

For-in loop

<cfscript>
 arr=["ColdFusion","Java","PHP","Ruby"];
 for (i in arr){
  writeOutput(i & " is a language" & "<br/>");
 }
</cfscript>

For-in loop (Struct)

<cfscript>
 myStruct=StructNew();
 myStruct.name="ColdFusion";
 myStruct.version="2016";
 myStruct.os="Windows";
 
 for (i in myStruct){
  writeOutput(i & ":" & myStruct[i] & "<br/>");
 }
</cfscript>

If-Else

<cfscript>
 arr=[2,3,4,5,6,7];
 // if-else
 
 if (ArraySum(arr)>=20){
  WriteOutput("Sum is: " & ArraySum(arr));
 }
 else{
  WriteOutput("Less than: " & ArraySum(arr));
 }
 
</cfscript>

switch

<cfscript>
 myLang="ColdFusion";
 switch (myLang){
  case "Java":
   WriteOutput("Language is: " & myLang);
   break;
  case "PHP":
   WriteOutput("Language is: " & myLang);
   break;
  case "Ruby":
   WriteOutput("Language is: " & myLang);
   break;
  default:
   WriteOutput("Language is: " & myLang);
   break;
 }
</cfscript>

arrayeach

<cfscript>
       myCities=["London","New York","Paris","Tokyo","Barcelona"];
       // Create a function that takes city as an argument  and prints the name of the cities as output
       // with delimiter as space
       ArrayEach(myCities,function(city){
             WriteOutput(city & "  ");
             }
       );
</cfscript>

structeach

<cfscript>
 myStruct=StructNew();
 myStruct.m1="Hello";
 myStruct.m2="World";
 myStruct.time=now();
 StructEach(myStruct,function(key,value){
  WriteOutput(key & value & "<br/>");
 });
</cfscript>

For loop (query)

<cfscript>
 myQuery=queryNew("empid,depid,name", "integer,integer,varchar",[
    [10, 101, "John"],
    [20, 120, "James"],
    [30, 205, "Peter"],
    [40, 530, "Jacob"],
    [50, 306, "Mary"],
    [60, 120, "Helen"]
 ]);
 for (i in myQuery){
  // Get rows
  WriteOutput("Row id: " & myQuery.CurrentRow & " " & "Emp id: " & i.empid & " " & "Name is: " & i.name & "<br/>");
 }
</cfscript>

ColdFusion components

// hello.cfc
component displayname="greetings" {
 function sayHello(){
  message="Hello World";
  return message;
 }
}

<cfscript>
 // instantiate object
 obj=new hello();
 WriteOutput(obj.sayHello()); 
</cfscript>

Exception handling with the cfscript tag

To handle exceptions with this tag, use try and catch statements, which are equivalent to the cftry and cfcatch tags. For each try statement, you must have a catch statement. In the catch block, the variable exceptionVariable contains the exception type. This variable is the equivalent of the cfcatch tag built-in variable cfcatch.Type. For more information, see Extending ColdFusion Pages with CFML Scripting in the Developing ColdFusion Applications.

Invoking ColdFusion components with the cfscript tag

CFScript invokes component methods using the CreateObject function. The following example shows how to invoke a component object with the cfscript tag, using ordered arguments:

<cfscript> 
    quote = CreateObject( "component", "nasdaq.quote" ) ; 
    <!--- Invocation using ordered arguments. ---> 
    res = quote.getLastTradePrice( "macr" ) ; 
</cfscript>

The following example shows how to use an attribute collection within the cfscript tag to pass parameters when invoking a component object. An attribute collection is a structure in which each key corresponds to a parameter name and each value is the parameter value passed for the corresponding key.

<cfscript> 
stArgs = structNew(); 
stArgs.zipcode = "55987"; 
</cfscript> 
... 
<cfinvoke 
webservice = "http://www.xmethods.net/sd/2001/TemperatureService.wsdl" 
method = "getTemp" 
argumentCollection = "#stArgs#" 
returnVariable = "aTemp" > 
<cfoutput>The temperature at zip code 55987 is #aTemp#</cfoutput>

In this example, the structure is created in a cfscript block, but you can use any ColdFusion method to create the structure.

Consuming web services with the cfscript tag

The following example shows how to consume a web service with the cfscript tag. You use the CreateObject function to connect to the web service.

<cfscript> 
ws = CreateObject("webservice", 
"http://www.xmethods.net/sd/2001/TemperatureService.wsdl"); 
xlatstring = ws.getTemp("55987"); 
writeoutput(xlatstring); 
</cfscript>

For more information, see Using Web Services in the Developing ColdFusion Applications.

Script support for tags

ColdFusion traditionally allowed you to build your applications using simple tags. ColdFusion 11 allows you to write all the tags in the script format in a very generic manner. The format for the generic syntax is as follows:

<cfscript>
cftag1 (att1=val1, att2=val2) // The parent tag
{
// First child tag having attributes in the parenthesis (Optional)
child_Tag1 (child_attr1='cv1', child_attr2='cv2') 

{
// Nested child tag
child_childTag (child_child_attr1=ccv1, child_child_attr2=ccv2); 

}
// Second child of parent tag
child_Tag2 (child2_attr1='cv1', child2_attr2='cv2');

}
</cfscript>

Note that the attributes of a tag must be enclosed within a parenthesis and also the attributes must be comma-separated.

Consider the following example:

<cfform name='myForm' action=''>
<cfgrid name="myGrid" query='userNameQuery'>
<cfgridcolumn name='firstName' id='firstName' type='string' />
<cfgridcolumn name='lastName' id='lastName' type='string' />
</cfgrid>
</cfform>

You have been used to writing ColdFusion code as mentioned in the above example. To give you more control, invoking tags inside the ColdFusion script block is now supported.

So, now you can write your code in the following manner:

<cfscript>
cfform (name='myForm', acton='')
{
cfgrid (name="myGrid", query='userNameQuery')
{
cfgridcolumn (name='firstName', id='firstName', type='string');
cfgridcolumn (name='lastName', id='LastName', type='string');
}
}
</cfscript>

The script support is not available for the following tags:

<cfscript>
<cfoutput> (use writeOutput() instead)
<cfdump> (use writeDump() instead)
<cfinvoke> (use invoke() instead)
<cfinvokeargument>
<cfobject> (use createObject instead)

Note:

Though the script equivalents of the above tags might work, they are not supported.

Using custom tags in scripts

Custom tags can also be used in <cfscript> blocks just like normal ColdFusion tags. For instance,

If there is a custom tag named cf_happybirthday to generate a birthday message which is used in the tag syntax like:

<cf_happybirthday name="Ted Cantor" birthDate="December 5, 1987">

The same can be written in the script syntax as :

cf_happybirthday (name="Ted Cantor", birthDate="December 5, 1987");

Also, script support for cfimport-based prefix custom tag is supported. You can use prefix-based custom tag in script blocks as follows:

<cfscript>
  cfimport(taglib=" ../importFolder/", prefix="myTags");
  myTags:customTag();
</cfscript>

In the above example, customTag is a CFM file under the importFolder directory.

Example

<p>This simple example shows variable declaration and manipulation. 
<cfif IsDefined("form.myValue")> 
<cfif IsNumeric(form.myValue)> 
<cfset x = form.myValue> 
<cfscript> 
y = x; 
z = 2 * y; 
StringVar = form.myString; 
</cfscript> 
<cfoutput> <p>twice #x# is #z#. 
<p>Your string value was: <b><I>#StringVar#</i></b> </cfoutput> 
<cfelse>

More like this

Adobe

Get help faster and easier

New user?