under license and may be used or copie d only in accordance with the
terms of such license. The content of this manual is furnished for
informational use only, is subject to change without notice, and
should not be construed as a commitment by Macromedia
Incorporated. Macromedia Incorporated assumes no responsibility
or liability for any errors or inaccuracies that may appear in this book.
Except as permitted by such license, no part of this publication may
be reproduced, stored in a retrieval system, or transmitted in any
form or by any means, electronic, mechanical, recording, or
otherwise, without the prior written permission of Macromedia
Incorporated.
ColdFusion and HomeSite are federally registered trademarks of
Macromedia Incorporated. HomeSite, the ColdFusion logo and the
Allaire logo are trademarks of Macromedia Incorporated in the USA
and other countries. Microsoft, Windows, Windows NT, Windows 95,
Microsoft Access, and FoxPro are registered trademarks of Microsoft
Corporation. Solaris is a trademark of Sun Microsystems Inc. UNIX is
a trademark of The Open Group. PostScript is a trademark of Adobe
Systems Inc. All other products or name brands are the trademarks
of their respective holders.
username = "name"
password = "password"
server = "server"
timeout = "timeout in seconds"
port = "port"
connection = "name"
proxyServer = "proxyserver"
retryCount = "number"
stopOnError = "Yes" or "No"
passive = "Yes" or "No">
<cfftp action = "file_or_dir_operation"
username = "name"
password = "password"
name = "query_name"
server = "server"
ASCIIExtensionList = "extensions"
transferMode = "mode"
failIfExists = "Yes" or "No"
directory = "directory name"
localFile = "filename"
remoteFile = "filename"
item = "directory or file"
existing = "file or directory name"
new = "file or directory name"
proxyServer = "proxyserver"
passive = "Yes" or "No">
cfgraph
<cfgraph type = "bar" or "horizontalBar"
query = "query name"
valueColumn = "query column"
itemColumn = "query column"
URL = "URL string"
URLColumn = "query column"
showValueLabel = "yes", "no", or "rollover"
valueLabelFont = "Arial", "Courier", or "Times"
valueLabelSize = number of points
valueLocation = "onBar" or "overBar"
scaleFrom = integer minimum value
scaleTo = integer maximum value
showItemLabel = "yes" or "no"
itemLabelFont = "Arial", "Courier", or "Times"
itemLabelSize = number of points
itemLabelOrientation = "horizontal" or "vertical"
title = "title text"
titleFont = "Arial", "Courier", or "Times"
fileFormat = "Flash", "gif" or "jpg"
barSpacing = integer number of pixels
graphHeight = integer number of pixels
graphWidth = integer number of pixels
backgroundColor = "Web color"
borderColor = "Web color"
borderWidth = integer number of pixels
depth = integer number of pixels
colorList = "Web color list"
gridLines = integer number of lines>
...
</cfgraph>
<cfgraph type = "line"
query = "query name"
valueColumn = "query column"
itemColumn = "query column"
scaleFrom = integer minimum value
scaleTo = integer maximum value
showItemLabel = "yes" or "no"
itemLabelFont = "Arial", "Courier", or "Times"
itemLabelSize = number of points
itemLabelOrientation = "horizontal" or "vertical"
title = "title text"
titleFont = "Arial", "Courier", or "Times"
CFML Quick Reference3
fileFormat = "Flash", "gif" or "jpg"
lineColor = "Web color"
lineWidth = integer number of pixels
fill = "yes" or "no"
graphHeight = integer number of pixels
graphWidth = integer number of pixels
backgroundColor = "Web color"
borderColor = "Web color"
borderWidth = integer number of pixels
depth = integer number of pixels
gridLines = integer number of lines>
...
</cfgraph>
<cfgraph type = "pie"
query = "query name"
valueColumn = "query column"
itemColumn = "query column"
<!--- data drill down attributes --->
URL = "URL string"
URLColumn = "query column"
<!--- pie chart value display attributes --->
showValueLabel = "yes", "no", or "rollover"
valueLabelFont = "Arial", "Courier", or "Times"
valueLabelSize = number of points
valueLocation = "inside" or "outside"
title = "title text"
titleFont = "Arial", "Courier", or "Times"
showLegend = "above", "below", "left", "right",
or "none"
legendFont = "Arial", "Courier", or "Times"
fileFormat = "Flash", "gif" or "jpg"
graphHeight = integer number of pixels
graphWidth = integer number of pixels
backgroundColor = "Web color"
borderColor = "Web color"
borderWidth = integer number of pixels
depth = integer number of pixels
colorList = "Web color list">
...
</cfgraph>
cfgraphdata
<cfgraphdata item = "data item"
value = data value
item = "label string"
color = "Web color"
URL = "URL string">
cfgrid
<cfgrid name = "name"
height = "integer"
width = "integer"
autoWidth = "Yes" or "No"
vSpace = "integer"
hSpace = "integer"
align = "value"
query = "query_name"
insert = "Yes" or "No"
delete = "Yes" or "No"
sort = "Yes" or "No"
font = "column_font"
fontSize = "size"
italic = "Yes" or "No"
bold = "Yes" or "No"
textColor = "Web color"
href = "URL"
hrefKey = "column_name"
target = "URL_target"
appendKey = "Yes" or "No"
highlightHref = "Yes" or "No"
onValidate = "javascript_function"
onError = "text"
gridDataAlign = "position"
gridLines = "Yes" or "No"
rowHeight = "pixels"
rowHeaders = "Yes" or "No"
rowHeaderAlign = "position"
rowHeaderFont = "font_name"
rowHeaderFontSize = "size"
rowHeaderItalic = "Yes" or "No"
rowHeaderBold = "Yes" or "No"
<cfcase value = "value" delimiters = "delimiters">
HTML and CFML tags
</cfcase>
additional <cfcase></cfcase> tags
<cfdefaultcase>
HTML and CFML tags
</cfdefaultcase>
<cftry>
... Add code here
<cfcatch type = "exceptiontype">
... Add exception processing code here
</cfcatch>
... Additional cfcatch blocks go here
</cftry>
ColdFusion returns a wide variety of variables, such as those
returned in a CFDIRECTORY or CFFTP operation. Variables
are usually referenced by "scoping" the variable according to
its type, as in Session.varname, or Application.varname.
Variable scope
ColdFusion supports the Variables scope. Unscoped variables created wit h the CFSE T tag acqu ire the V a riable s scope
by default. For example, the variable created by:
<CFSET linguist = Chomsky>
can be referenced as:
#Variables.linguist#
Client variables
These client variables are read-only:
Client.CFID
Client.CFToken
Client.HitCount
Client.LastVisit
Client.TimeCreated
Client.URLToken
Server variables
Use the Server. prefix to reference server variables:
Server.ColdFusion.ProductName
Server.ColdFusion.ProductVersion
Server.ColdFusion.ProductLevel
Server.ColdFusion.SerialNumber
Server.ColdFusion.SupportedLocales
Server.OS.Name
Server.OS.AdditionalInformation
Server.OS.Version
Server.OS.BuildNumber
Application and session variables
Use CFAPPLICATION to enable application and session variables. They are referenced as:
Application.myvariable
Session.myvariable
Use CFLOCK to ensure that modifications to sh ared data
occur one after another. See CFML Language Reference
description of CFLOCK for details.
The predefined application and session variables are:
Application.ApplicationName
Session.CFID
Session.CFToken
Session.URLToken
20 CFML Quick Reference
Custom tag variable s
Any ColdFusion custom tag returns the following variables:
A custom tag can also set a Caller variable to provide information to the caller. The Caller variable is set a s follows:
<CFSET Caller.variable_name = "value">
The calling page can access the variable with the <CFOUTPUT> tag:
<CFOUTPUT>#Caller.variable_name#</CFOUTPUT>
Request variable
Request variables store data that pertains to the processing
of a single page request. Request variables allow you to store
data in a structure tha t can be passe d to ne sted tags , such a s
Custom Tags, and processed once.
Set a Request variable to provide information to nested tags.
The Request variab le is set as follows:
Each nested tag can access the variable with the <CFOUTPUT> tag:
<CFOUTPUT>#Request.field_name1#</CFOUTPUT>
Form vari able
ColdFusion supports the Form variable FieldNames. FieldNames returns the names of the fields on a form. You can
use it on the action page associated with a form.
Form.FieldNames
CFML Quick Reference21
ColdFusion Tag-Specific Variables
A number of ColdFusion tags return data as variables. For
example, the CFFILE tag returns fi le size information in the
FileSize variable, referenced as CFFILE.FileSize.
The following tags return data that can be referenced in variables:
• CFCATCH
• CFDIRECTORY
• CFERROR
• CFFILE
• CFFTP
• CFHTTP
• CFINDEX
• CFLDAP
• CFMAIL
• CFPOP
• CFQUERY
• CFREGISTRY
• CFSEARCH
• CFSERVLET
• CFSTOREDPROC
ColdFusion query variables
Any ColdFusion tag that returns a query object supports the
following variables:
queryname.CurrentRow
queryname.RecordCount
queryname.ColumnList
Where queryname is the value of the NAME attribute in each
tag.
CFCATCH variables
Within a CFCATCH block, the properties of the active exception can be accessed as variables:
CFCATCH.Type
CFCATCH.Message
CFCATCH.Detail
CFCATCH.ErrNumber
CFCATCH.NativeErrorCode
CFCATCH.SQLState
CFCATCH.LockName
CFCATCH.LockOperation
CFCATCH.MissingFileName
CFCATCH.TagContext
CFCATCH.ErrorCode
CFCATCH.ExtendedInfo
22 CFML Quick Reference
CFDIRECTORY variables
When used with ACTION=LIST, CFDIRECTORY returns a
query object. Queryname is the value of the NAME attribute
used in the CFDIRECTORY operation.
When CFERROR generates an error page, the following error
variables are available if you have specified TYPE="Request",
TYPE="Exception" or TYPE="Monitor."
NOTE: You can substitute the prefix CFER ROR for Er ror if yo u
have specified the type as "Exception" or "Monitor"; for example, CFERROR.Diag nostics, CFERROR.Mailto or CFERROR.DateTime.
CFML Quick Reference23
CFFILE ACTION=Upload variables
File variables are read-only. Use the CFFILE. prefix to reference file variables: CFFILE.ClientDirector y. Note that
although still supported, the File. prefix is deprecated in
favor of the CFFILE. prefix.
CFFILE.AttemptedServerFile
CFFILE.ClientDirectory
CFFILE.ClientFile
CFFILE.ClientFileExt
CFFILE.ClientFileName
CFFILE.ContentSubType
CFFILE.ContentType
CFFILE.DateLastAccessed
CFFILE.FileExisted
CFFILE.FileSize
CFFILE.FileWasAppended
CFFILE.FileWasOverwritten
CFFILE.FileWasRenamed
CFFILE.FileWasSaved
CFFILE.OldFileSize
CFFILE.ServerDirectory
CFFILE.ServerFile
CFFILE.ServerFileExt
CFFILE.ServerFileName
CFFILE.TimeCreated
CFFILE.TimeLastModified
CFFTP error variables
When you use the CFFTP STOPONERROR attribute, three
variables are populated:
CFFTP.Succeeded
CFFTP.ErrorCode
CFFTP.ErrorText
CFFTP ReturnValue variable
Some of the CFFTP file and directory operations provide a
return value, in the variable:
CFFTP.ReturnValue
The value of the CFFTP.ReturnValue variable is determined
by the results of the ACTION attribute used in CFFTP. When
you specify any of the following actions, CFFTP returns a
value:
• GetCurrentDir
• GetCurrentURL
• ExistsDir
• ExistsFile
• Exists
24 CFML Quick Reference
CFFTP query object columns
When you use CFFTP with the ListDir action, CFFTP returns a
query object. Queryname is the value of the NAME attribute
used in the CFFTP operation. Row is the row number for each
file/directory entry returned by the ListDir ope r ation.
CFHTTP GET operations can r e tu rn te xt a nd bi na ry files . Files
are downloaded and the contents stored in a variable or file,
depending on the MIME type.
CFPOP returns the following result columns, depending on
the value of the ACTION attribute and the use of other
attributes like A TTACHMENTPATH. Queryname is the value of
the NAME attribute used in the CFPOP operation.
In addition to returning data from a ColdFusion data source,
the CFQUERY tag returns information about the query:
CFQUERY.ExecutionTime
CFQUERY also uses the name of the query to scope data
about the q uery:
queryname.CurrentRow
queryname.RecordCount
queryname.ColumnList
The CFSTOREDPROC tag also return s:
CFSTOREDPROC.ExecutionTime
CFSTOREDPROC.StatusCode
CFREGISTRY variables
The CFREGISTRY tag returns a query record set that you can
reference after executing the GetAll action. Queryname is
the value of the NAME attribute used in the CFREGISTRY
operation.
queryname.Entry
queryname.Type
queryname.Value
CFSEARCH variab les
Every CFSEARCH operation returns the following variables.
Searchname is the value of the NAME attribute used in the
CFSEARCH operation.
searchname.URL
searchname.Key
searchname.Title
searchname.Score
searchname.Custom1 and Custom2
searchname.Summary
searchname.RecordCount
searchname.CurrentRow
searchname.RecordsSearched
searchname.ColumnList
CFSERVLET variables
If the WRITEOUTPUT attribute is NO, CFSERVLET returns the
text output of the servlet in the following variable:
CFSERVLET.Output
If the servlet returns any response headers, they are in the
CFSERVLET return structure. Each response header can be
accessed through a key. In the following syntax, servletRe-sponseHeader is a key, which is the name of the response
header set in the servlet:
CFSERVLET.servletResponseHeader
26 CFML Quick Reference
Standard CGI Variables
This is a list of CGI 1.1 variables many Web servers create
when a CGI script is called.
NOTE: The CGI variables that are available for your use vary
with the Web server and configuration. Some of the following variables may not be available to you.
CLIENT_CERT_ENCODED variables are available only if you
are using client certificates.
CFML Quick Reference27
ColdFusion Studio Keyboard Shortcuts
Studio offers a full set of keyboard commands for its tools
and functions. The list below generally matches the order of
the menu commands, with related shortcuts added.
You can change shortcut key combinations and add new
ones by opening the Options > Custo m ize dialog and selecting the Keyboard Shortcuts tab.
File and document keyboard shortcuts
File and Document Shortcuts
CommandKey
File > Open Ctrl + O
File > Save Ctrl + S
File > Save AsShift + Ctrl + S
File > CloseCtrl + W
File > Close AllShift + Ctrl + W
File > PrintCtrl + P
Open default templateCTRL + N
Insert Code Template text/open listCtrl + J
Edit > UndoCtrl + Z
Edit > RedoShift + Ctrl + Z
Edit > Repeat Last TagCtrl + Q
Edit > CutCtrl + X
Edit > CopyCtrl + C
Edit > PasteCtrl + V
Edit > Select AllCtrl + A
Edit > IndentShift + Ctrl + . (period)
Edit > UnindentShift + Ctrl + , (comma)
Edit > Toggle BookmarkCtrl + K
Edit > Goto Next BookmarkShift + Ctrl + K
Edit > Goto lineCtrl + G
Goto previous documentShift + Ctrl + Tab
Goto next documentCtrl + Tab
Goto next start tagCtrl + ] (right bracket)
28 CFML Quick Reference
File and Document Shortcuts (Continued)
CommandKey
Goto previous start tagCtrl + [ (left bracket)
Go to top of windowCtrl + PgUp
Go to bottom of windowCtrl + PgDn
Delete lineCtrl + Y
Delete stringCtrl + Del
Delete previous stringCtrl + Backspace
Search > FindCtrl + F
Search > ReplaceCtrl + R
Search > Find NextF3
Search > Extended FindShift + Ctrl + F
Search > Extended ReplaceShift + Ctrl + R
Tools > Tag ChooserCtrl+E
Tools > Expression BuilderShift + Ctrl + E
Tools > Spell CheckF7
Tools > Spell Check AllShift + F7
Tools > Mark Spelling ErrorsCtrl + F7
Tools > Validate DocumentShift + F6
Tools > Validate Current TagF6
Open Development Mappings
dialog
Open CodeSweeper dialogCtrl + Alt + F
Open Customize dialog Shift + F8
Execute current document as
ActiveScript
Options > SettingsF8
Options > CustomizeShift + F8
Tags > Insert Start tag < >Ctrl + , (comma)
Tags > Insert End tag < />Ctrl + . (period)
Tags > Open Anchor dialogShift + Ctrl + A
Tags > Insert Bold tagCtrl + B
CFML Quick Reference29
Alt + M
Shift + Ctrl + Q
File and Document Shortcuts (Continued)
CommandKey
Tags > Insert BR tagShift + Ctrl + B
Tags > Insert BR tag and new lineCtrl + Enter
Tags > Insert Align Center codeShift + Ctrl + C
Tags > Insert Comment tagShift + Ctrl + M
Tags > Open IMG dialogShift + Ctrl + I
Tags > Insert Italic tagCtrl + I
Tags > Insert Non-breaking SpaceShift + Ctrl + Spacebar
Tags > Insert Paragraph tagShift + Ctrl + P
Tags > Find Matching TagCtrl + M
Tags > Show Tag Tip for current tag
(Esc to close)
Tags > Edit Current TagCtrl + F4
Tags > Inspect Current TagF4
Insert Underline tagCtrl + U
Insert # (pound sign)CTRL + 3
View > Full ScreenF10
View > QuickBarCtrl + H
View > Resources TabF9
View > Results WindowShift + Ctrl + L
View > Special CharactersShift + Ctrl + X
View > Edit/Browse modes F12
View > Edit/Design modesShift + F12
View > Open in Macromedia
DreamWeaver
Open current document in external
browser
Toggle focus between Editor and
Resource tabs
F2
Ctrl + D
F11
Shift + F9
Help > Show Help for Current Tag
(HTML)
30 CFML Quick Reference
F1
File and Document Shortcuts (Continued)
CommandKey
Show Tag Tip for current tag (Esc to
close)
Show Tag Insight for current tag (Esc
to close)
F2
Shift + F2
Debugger Keyboard Shortcuts
Debugger Shortcuts
CommandKey
Start/ContinueCtrl + F5
Start - No debuggingCtrl + Alt + F5
EndAlt + F5
RestartCtrl + Shift + F5
Step IntoCtrl + F8
Step OverCtrl + F9
Run To CursorCtrl + F11
VariablesAlt + Q
Watches Alt + W
RecordsetsAlt + R
StackAlt + K
OutputAlt + P
BreakpointsAlt + B
Toggle BreakpointAlt + X
Clear All BreakpointsAlt + F6
Debug SettingsAlt + Y
Development MappingsAlt + M
CFML Quick Reference31
32 CFML Quick Reference
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.