Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
<?xml version="1.0" encoding="UTF-8"?>
<dictionary>
<tags>
<!--
cfabort
showError = "error_message"
-->
<tag endtagrequired="false" name="cfabort" single="true"
xmlstyle="false">
<help><![CDATA[
Stops the processing of a CFML page at the tag location.
CFML returns everything that was processed before the
tag. The tag is often used with conditional logic to stop
processing a page when a condition occurs.
]]></help>
<parameter name="showerror" required="false" type="String">
<help><![CDATA[
Error to display, in a standard CFML error page,
when tag executes
]]></help>
<values/>
</parameter>
<parameter name="attributecollection" required="false" type="String">
<help><![CDATA[
You can specify this tag's attributes in an attributeCollection whose value is a
structure. Specify the structure name in the attributeCollection and use the tag’s
attribute names as structure keys.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfapplet
appletSource = "applet_name"
name = "form_variable_name"
height = "height_in_pixels"
width = "width_in_pixels"
vSpace = "space_above_and_below_in_pixels"
hSpace = "space_on_each_side_in_pixels"
align = "alignment_option"
notSupported = "message_to_display_for_nonJava_browser"
param_1 = "applet_parameter_name"
param_2 = "applet_parameter_name"
param_n = "applet_parameter_name"
-->
<tag endtagrequired="false" name="cfapplet" single="true"
xmlstyle="false">
<help><![CDATA[
This tag references a registered custom Java applet. To
register a Java applet, in the CFML Administrator, click
Extensions/Java Applets.
Using this tag within a cfform tag is optional. If you use it
within cfform, and the method attribute is defined in the
Administrator, the return value is incorporated into the
form.
]]></help>
<parameter name="appletsource" required="true" type="String">
<help><![CDATA[
Name of registered applet
]]></help>
<values/>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Form variable name for applet
]]></help>
<values/>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
Control's height, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Control's width, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="vspace" required="false" type="Numeric">
<help><![CDATA[
Vertical margin above and below control, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="hspace" required="false" type="Numeric">
<help><![CDATA[
Horizontal spacing to left and right of control, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="align" required="false" type="String">
<help><![CDATA[
Alignment
]]></help>
<values>
<value option="top"/>
<value option="left"/>
<value option="bottom"/>
<value option="baseline"/>
<value option="texttop"/>
<value option="absbottom"/>
<value option="middle"/>
<value option="absmiddle"/>
<value option="right"/>
</values>
</parameter>
<parameter name="notsupported" required="false" type="String">
<help><![CDATA[
Text to display if a page that contains a Java applet-based
cfform control is opened by a browser that does not
support Java or has Java support disabled.
Default:
"<b>Browser must support Java to <br>view ColdFusion Java
Applets!</b>"
]]></help>
<values default="<b>Browser must support Java to <br>view ColdFusion Java Applets!</b>"/>
</parameter>
<possiblecombinations>
<combination attributename="appletsource">
<required>appletsource,name</required>
<optional>align,height,hspace,notsupported,vspace,width</optional>
</combination>
<combination attributename="name">
<required>appletsource,name</required>
<optional>align,height,hspace,notsupported,vspace,width</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfapplication
name = "application_name"
loginStorage = "cookie" or "session"
clientManagement = "boolean"
clientStorage = "datasource_name" or "Registry" or "Cookie"
setClientCookies = "boolean"
sessionManagement = "boolean"
sessionTimeout = #CreateTimeSpan(days, hours, minutes, seconds)#
applicationTimeout = #CreateTimeSpan(days, hours, minutes, seconds)#
setDomainCookies = "boolean"
scriptProtect = "all", "none" or a list of scopes
-->
<tag endtagrequired="false" name="cfapplication" single="true"
xmlstyle="false">
<help><![CDATA[
Defines the scope of a CFML application; enables and
disables storage of Client variables; specifies the Client
variable storage mechanism; enables Session variables; and
sets Application variable timeouts.
]]></help>
<return name="application" type="application"/>
<return name="session" type="session"/>
<return name="client" type="client"/>
<parameter name="name" required="false" type="String">
<help><![CDATA[
Name of application. Up to 64 characters
]]></help>
<values/>
</parameter>
<parameter name="loginstorage" required="false" type="String">
<help><![CDATA[
cookie: store login information in the Cookie scope.
session: store login information in the Session scope.
]]></help>
<values default="cookie">
<value option="cookie"/>
<value option="session"/>
</values>
</parameter>
<parameter name="clientmanagement" required="false" type="boolean">
<help><![CDATA[
enables client variables
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="clientstorage" required="false" type="String">
<help><![CDATA[
How client variables are stored
* datasource_name: in ODBC or native data source.
You must create storage repository in the
Administrator.
* registry: in the system registry.
* cookie: on client computer in a cookie. Scalable.
If client disables cookies in the browser, client
variables do not work
]]></help>
<values default="registry">
<value option="cookie"/>
<value option="registry"/>
<value option="datasource_name"/>
</values>
</parameter>
<parameter name="setclientcookies" required="false" type="boolean">
<help><![CDATA[
No: CFML does not automatically send CFID and CFTOKEN
cookies to client browser; you must manually code CFID and
CFTOKEN on the URL for every page that uses Session or
Client variables
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="sessionmanagement" required="false" type="boolean">
<help><![CDATA[
enables session variables
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="sessiontimeout" required="false" type="Timespan">
<help><![CDATA[
Lifespan of session variables. CreateTimeSpan function and
values in days, hours, minutes, and seconds, separated by
commas
]]></help>
<values/>
</parameter>
<parameter name="applicationtimeout" required="false" type="Timespan">
<help><![CDATA[
Lifespan of application variables. CreateTimeSpan function
and values in days, hours, minutes, and seconds, separated
by commas.
]]></help>
<values/>
</parameter>
<parameter name="setdomaincookies" required="false" type="boolean">
<help><![CDATA[
Yes: Sets CFID and CFTOKEN cookies for a domain (not a host)
Required, for applications running on clusters.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="scriptprotect" required="false" type="String">
<help><![CDATA[
Specifies whether to protect variables from cross-site scripting attacks.
- none: do not protect variables
- all: protect Form, URL, CGI, and Cookie variables
- comma-delimited list of ColdFusion scopes: protect variables in the specified scopes
]]></help>
<values>
<value option="none"/>
<value option="all"/>
<value option="form"/>
<value option="url"/>
<value option="cookie"/>
<value option="cgi"/>
<value option="form,url"/>
<value option="form,url,cookie"/>
<value option="form,url,cookie,cgi"/>
</values>
</parameter>
<parameter name="securejsonprefix" required="false" type="String">
<help><![CDATA[ The security prefix to put in front of the value that a ColdFusion function returns in JSON-format
in response to a remote call if the secureJSON setting is true.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="securejson" required="false" type="Boolean">
<help><![CDATA[ A Boolean value that specifies whether to add a security prefix in front of any value that a ColdFusion function returns in JSON-format
in response to a remote call.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="serverSideFormValidation" required="false" type="Boolean">
<help><![CDATA[ Enable/Disable ColdFusion’s server side validation on CFFORM.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfargument
name = "String"
type = "data type"
required = "boolean"
default = "default value"
displayname = "descriptive name"
hint = "extended description"
-->
<tag allowanyattribute="true" canHaveAttributeCollection="false" endtagrequired="false"
name="cfargument" single="true"
xmlstyle="false">
<help><![CDATA[
Creates a parameter definition within a component definition.
Defines a function argument. Used within a cffunction tag.
]]></help>
<return parameter="name" type="Any"/>
<parameter name="name" required="true" returnVarType="variablename" type="Stirng">
<help><![CDATA[
An argument name.
]]></help>
<values/>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
a type name; data type of the argument.
]]></help>
<values>
<value option="any"/>
<value option="array"/>
<value option="binary"/>
<value option="boolean"/>
<value option="date"/>
<value option="guid"/>
<value option="numeric"/>
<value option="query"/>
<value option="string"/>
<value option="struct"/>
<value option="uuid"/>
<value option="xml"/>
<value option="variablename"/>
<value option="(component name)"/>
</values>
</parameter>
<parameter name="required" required="false" type="boolean">
<help><![CDATA[
Whether the parameter is required to execute the component
method.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="default" required="false" type="String">
<help><![CDATA[
If no argument is passed, specifies a default argument
value.
]]></help>
<values/>
</parameter>
<parameter name="displayname" required="false" type="String">
<help><![CDATA[
Meaningful only for CFC method parameters. A value to be
displayed when using introspection to show information
about the CFC.
]]></help>
<values/>
</parameter>
<parameter name="hint" required="false" type="String">
<help><![CDATA[
Meaningful only for CFC method parameters. Text to be
displayed when using introspection to show information
about the CFC. The hint attribute value follows the
displayname attribute value in the parameter description
line. This attribute can be useful for describing the
purpose of the parameter
]]></help>
<values/>
</parameter>
</tag>
<!--
cfassociate
baseTag = "base_tag_name"
dataCollection = "collection_name"
-->
<tag endtagrequired="false" name="cfassociate" single="true"
xmlstyle="false">
<help><![CDATA[
Allows subtag data to be saved with a base tag. Applies only
to custom tags.
]]></help>
<parameter name="basetag" required="true" type="String">
<help><![CDATA[
Base tag name
]]></help>
<values/>
</parameter>
<parameter name="datacollection" required="false" returnVarType="Struct" type="String">
<help><![CDATA[
Structure in which base tag stores subtag data
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfbreak
-->
<tag endtagrequired="false" canHaveAttributeCollection="false" name="cfbreak" single="true"
xmlstyle="false">
<help><![CDATA[
Used within a cfloop tag. Breaks out of a loop.
]]></help>
</tag>
<!--
cfcache
action = "action"
directory = "directory_name"
timespan = "value"
expireURL = "wildcarded_URL_reference"
username = "username"
password = "password"
port = "port_number"
protocol = "protocol"
-->
<tag endtagrequired="false" name="cfcache" single="false"
xmlstyle="false">
<help><![CDATA[
Stores a copy of a page on the server and/or client computer,
to improve page rendering performance. To do this, the tag
creates temporary files that contain the static HTML returned
from a CFML page.
Use this tag if it is not necessary to get dynamic content each
time a user accesses a page.
You can use this tag for simple URLs and for URLs that contain
URL parameters.
]]></help>
<parameter name="action" required="false" type="String">
<help><![CDATA[
* cache: server-side and client-side caching.
* flush: refresh cached page(s).
* clientcache: browser-side caching only. To cache a personalized page, use this option.
* servercache: server-side caching only. Not recommended.
* optimal: same as "cache".
]]></help>
<values>
<value option="cache"/>
<value option="flush"/>
<value option="clientcache"/>
<value option="servercache"/>
<value option="optimal"/>
<value option="get"/>
<value option="put"/>
</values>
</parameter>
<parameter name="directory" required="false" type="String">
<help><![CDATA[
Absolute path of cache directory.
]]></help>
<values/>
</parameter>
<parameter name="timespan" required="false" type="Timespan">
<help><![CDATA[
The interval until the page is flushed from the cache.
]]></help>
<values/>
</parameter>
<parameter name="expireurl" required="false" type="String">
<help><![CDATA[
Used with action = "flush". A URL reference. CFML
matches it against the mappings in the specified cache
directory. Can include wildcards. For example:
"*/view.cfm?id=*".
]]></help>
<values/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
A username
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
A password
]]></help>
<values/>
</parameter>
<parameter name="port" required="false" type="Numeric">
<help><![CDATA[
Remote port to which to connect
]]></help>
<values/>
</parameter>
<parameter name="protocol" required="false" type="String">
<help><![CDATA[
Protocol that is used to create URL from cache.
]]></help>
<values>
<value option="http://"/>
<value option="https://"/>
</values>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
For action="set", object which needs to be stored
]]></help>
<values/>
</parameter>
<parameter name="metadata" required="false" returnVarType="Struct" type="String">
<help><![CDATA[
Name of the struct variable
]]></help>
</parameter>
<parameter name="stripwhitespace" required="false" type="Boolean">
<help><![CDATA[
Reduces whitespace
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="throwonerror" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether t throw an error if the
flush
action encounters an error. Otherwise the action does not generate an error if it fails. If this attribute is
true
you can handle the error in a
cfcatch
block, for example, if a specified id value is invalid
]]></help>
</parameter>
<parameter name="id" required="false" type="String">
<help><![CDATA[
Id of the cached object
]]></help>
</parameter>
<parameter name="key" required="false" type="String">
<help><![CDATA[
key to access cache
]]></help>
</parameter>
<parameter name="usecache" required="false" type="Boolean">
<help><![CDATA[
to use cache or not (if false it will process the content each time)
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="dependson" required="false" type="String">
<help><![CDATA[
Comma seperated list of all variables on which this cache would depend
]]></help>
</parameter>
<parameter name="idletime" required="false" type="Numeric">
<help><![CDATA[
Flushes the cached item if it is not accessed for the specified time span.
]]></help>
</parameter>
<parameter name="cachedirectory"
required="false" type="String">
<help><![CDATA[
Cache directory
]]></help>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
name of return variable, valid with action="get"
]]></help>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfcalendar
name = "name of calendar"
height = "height"
width = "width"
selectedDate = "date"
mask = "returned date format"
startRange = "first disabled date"
endRange = "last disabled date"
disabled = "true, false, or no attribute value"
mask = "character pattern"
dayNames = "days-of-the-week labels"
monthNames = "month labels"
onChange = "actionscript to invoke"
-->
<tag endtagrequired="false" name="cfcalendar" single="true"
xmlstyle="false">
<help><![CDATA[
Puts an interactive Macromedia Flash format calendar in an HTML
or Flash form. Not supported in XML format forms. The calendar
lets a user select a date for submission as a form variable.
]]></help>
<parameter name="name" required="true" returnVarType="variablename" type="String">
<help><![CDATA[
The name of the calendar.
]]></help>
<values/>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
The vertical dimension of the calendar specified in pixels.
]]></help>
<values/>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
The horizontal dimension of the calendar specified in pixels.
]]></help>
<values/>
</parameter>
<parameter name="selecteddate" required="false" type="String">
<help><![CDATA[
The date that is initially selected. It is highlighted in a
color determined by the form skin. Must be in mm/dd/yyyy
or dd/mm/yyyy format, depending on the current locale.
(Use the setlocale tag to set the locale, if necessary.)
]]></help>
<values/>
</parameter>
<parameter name="startrange" required="false" type="String">
<help><![CDATA[
The start of a range of dates that are disabled. Users
cannot select dates from this date through the date
specified by the endRange attribute.
]]></help>
<values/>
</parameter>
<parameter name="endrange" required="false" type="String">
<help><![CDATA[
The end of a range of dates that are disabled. Users
cannot select dates from the date specified by the
startRange attribute through this date.
]]></help>
<values/>
</parameter>
<parameter name="disabled" required="false" type="boolean">
<help><![CDATA[
Disables all user input, making the control read only.
To disable input, specify disabled without an attribute
or disabled="true". To enable input, omit the attribute
or specify disabled="false".
Default is: false
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="mask" required="false" type="String">
<help><![CDATA[
A pattern that specifies the format of the submitted date.
Mask characters are:
- D = day, can use 0-2 mask characters
- M = month, can use 0-4 mask characters
- Y = year, can use 0, 2, or 4 characters
- E = day in week, can use 0-4 characters
- Any other character = put the character in the specified location
Default is: MM/DD/YYYY
]]></help>
<values default="MM/DD/YYYY">
<value option="MM/DD/YYYY"/>
<value option="DD/MM/YYYY"/>
<value option="MM/YYYY"/>
<value option="MM/YY"/>
<value option="YYYY-MM-DD"/>
<value option="EEE DD. MMM YYYY"/>
</values>
</parameter>
<parameter name="firstdayofweek" required="false" type="Numeric">
<help><![CDATA[
Integer in the range 0-6 specifying the first day of the
week in the calendar, 0 indicates Sunday, 6 indicates Saturday.
Default is: 0
]]></help>
<values default="0">
<value option="0"/>
<value option="1"/>
<value option="2"/>
<value option="3"/>
<value option="4"/>
<value option="5"/>
<value option="6"/>
</values>
</parameter>
<parameter name="daynames" required="false" type="String">
<help><![CDATA[
A comma-delimited list that sets the names of the
weekdays displayed in the calendar. Sunday is the
first day and the rest of the weekday names follow in
the normal order.
Default is: S,M,T,W,Th,F,S
]]></help>
<values default="S,M,T,W,Th,F,S">
<value option="S,M,T,W,Th,F,S"/>
<value option="Sunday,Monday,Tuesday,Wednesday,Thursday,Friday,Saturday"/>
<value option="Sun,Mon,Tue,Wed,Thu,Fri,Sat"/>
</values>
</parameter>
<parameter name="monthnames" required="false" type="String">
<help><![CDATA[
A comma-delimited list of the month names that are
displayed at the top of the calendar.
]]></help>
<values default="January,February,March,April,May,June,July,August,September,October,November,December">
<value option="January,February,March,April,May,June,July,August,September,October,November,December"/>
<value option="Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec"/>
</values>
</parameter>
<parameter name="enabled" required="false" type="boolean">
<help><![CDATA[
Flash only: Specifying whether the control is enabled. A
disabled control appears in light gray. This is the inverse
of the disabled attribute.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="visible" required="false" type="boolean">
<help><![CDATA[
Flash only: Specifying whether to show the control. Space
that would be occupied by an invisible control is blank.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="tooltip" required="false" type="String">
<help><![CDATA[
Flash only: Text to display when the mouse pointer hovers
over the control.
]]></help>
<values/>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
Flash only: Actionscript style or styles to apply to the calendar.
Default is: haloGreen
]]></help>
<values>
<value option="haloBlue"/>
<value option="haloGreen"/>
<value option="haloOrange"/>
<value option="haloSilver"/>
</values>
</parameter>
<parameter name="onchange" required="false" type="String">
<help><![CDATA[
Flash only: ActionScript that runs when the user selects a
date.
]]></help>
<values/>
</parameter>
<parameter name="onblur" required="false" type="String">
<help><![CDATA[
Flash only: ActionScript that runs when the user selects a
date.
]]></help>
<values/>
</parameter>
<parameter name="onfocus" required="false" type="String">
<help><![CDATA[
Flash only: ActionScript that runs when the user selects a
date.
]]></help>
<values/>
</parameter>
</tag>
<!--
cfcase
value = "value or delimited set of values"
delimiters = "delimiter characters"
-->
<tag endtagrequired="true" canHaveAttributeCollection="false" name="cfcase" single="false"
xmlstyle="true">
<help><![CDATA[
Used only inside the cfswitch tag body. Contains code to
execute when the expression specified in the cfswitch tag has
one or more specific values.
]]></help>
<parameter name="value" required="true" type="String">
<help><![CDATA[
The value or values that the expression attribute of the
cfswitch tag must match. To specify multiple matching
values, separate the values with the delimiter character.
The value or values must be simple constants or constant
expressions, not variables.
]]></help>
<values/>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
Specifies the delimiter character or characters that
separate multiple values to match. If you specify multiple
delimiter characters, you can use any of them to separate
the values to be matched.
]]></help>
<values default=",">
<value option=","/>
<value option=";"/>
<value option="|"/>
<value option=":"/>
</values>
</parameter>
<possiblecombinations>
<combination attributename="value">
<required>value</required>
<optional>delimiters</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfcatch
type = "exceptiontype"
[Exception processing code here]
/cfcatch
-->
<tag endtagrequired="true" canHaveAttributeCollection="false" name="cfcatch" createsScopeVar="true" single="false"
xmlstyle="false">
<help><![CDATA[
Used inside a cftry tag. Together, they catch and process
exceptions in CFML pages. Exceptions are events that
disrupt the normal flow of instructions in a CFML page,
such as failed database operations, missing include files, and
developer-specified events.
]]></help>
<parameter name="type" required="false" type="String">
<help><![CDATA[
* application: catches application exceptions
* database: catches database exceptions
* template: catches ColdFusion page exceptions
* security: catches security exceptions
* object: catches object exceptions
* missingInclude: catches missing include file exceptions
* expression: catches expression exceptions
* lock: catches lock exceptions
* custom_type: catches the specified custom exception type that is defined in a cfthrow tag
* searchengine: catches Verity search engine exceptions
* any: catches all exception types
]]></help>
<values>
<value option="application"/>
<value option="database"/>
<value option="template"/>
<value option="security"/>
<value option="object"/>
<value option="missinginclude"/>
<value option="expression"/>
<value option="lock"/>
<value option="custom_type"/>
<value option="searchengine"/>
<value option="any"/>
</values>
</parameter>
</tag>
<!--
cfchart
format = "flash, jpg, png"
chartHeight = "integer number of pixels"
chartWidth = "integer number of pixels"
scaleFrom = "integer minimum value"
scaleTo = "integer maximum value"
showXGridlines = "boolean"
showYGridlines = "boolean"
gridlines = "integer number of lines"
seriesPlacement = "default, cluster, stacked, percent"
foregroundColor = "Hex value or Web color"
backgroundColor = "Hex value or Web color"
dataBackgroundColor = "Hex value or Web color"
showBorder = "boolean"
font = "font name"
fontSize = "integer font size"
fontBold = "boolean"
fontItalic = "boolean"
labelFormat = "number, currency, percent, date"
xAxisTitle = "title text"
yAxisTitle = "title text"
xAxisType = "scale or category"
yAxisType = "scale or category"
sortXAxis = "boolean"
show3D = "boolean"
xOffset = "number between -1 and 1"
yOffset = "number between -1 and 1"
rotated = "boolean"
showLegend = "boolean"
tipStyle = "MouseDown, MouseOver, none"
tipBGColor = "hex value or web color"
showMarkers = "boolean"
markerSize = "integer number of pixels"
pieSliceStyle = "solid, sliced"
url = "onClick destination page"
name = "String"
title = "title of chart"
style = "Style of chart"
/cfchart
-->
<tag endtagrequired="true" name="cfchart" single="false"
xmlstyle="true">
<help><![CDATA[
Generates and displays a chart.
]]></help>
<parameter name="format" required="false" type="String">
<help><![CDATA[
File format in which to save graph.
]]></help>
<values default="false">
<value option="flash"/>
<value option="jpg"/>
<value option="png"/>
</values>
</parameter>
<parameter name="chartheight" required="false" type="Numeric">
<help><![CDATA[
Chart height; integer number of pixels
]]></help>
<values default="240"/>
</parameter>
<parameter name="chartwidth" required="false" type="Numeric">
<help><![CDATA[
Chart width; integer number of pixels
]]></help>
<values default="320"/>
</parameter>
<parameter name="scalefrom" required="false" type="Numeric">
<help><![CDATA[
Y-axis minimum value; integer
]]></help>
<values/>
</parameter>
<parameter name="scaleto" required="false" type="Numeric">
<help><![CDATA[
Y-axis max value; integer
]]></help>
<values/>
</parameter>
<parameter name="showxgridlines" required="false" type="boolean">
<help><![CDATA[
yes: display X-axis gridlines
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="showygridlines" required="false" type="boolean">
<help><![CDATA[
yes: display Y-axis gridlines
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="gridlines" required="false" type="Numeric">
<help><![CDATA[
Number of grid lines to display on value axis, including
axis; positive integer.
]]></help>
<values default="10"/>
</parameter>
<parameter name="seriesplacement" required="false" type="String">
<help><![CDATA[
Applies to charts that have more than one data series.
Relative positions of series.
]]></help>
<values default="default">
<value option="default"/>
<value option="cluster"/>
<value option="stacked"/>
<value option="percent"/>
</values>
</parameter>
<parameter name="foregroundcolor" required="false" type="String">
<help><![CDATA[
color for control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values default="black">
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="backgroundcolor" required="false" type="String">
<help><![CDATA[
Color of the area between the data background and the chart
border, around labels and around the legend. Hexadecimal
value or supported named color. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values>
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="showborder" required="false" type="boolean">
<help><![CDATA[
Whether to display a border around the chart
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="databackgroundcolor" required="false" type="String">
<help><![CDATA[
color for control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values default="white">
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="font" required="false" type="String">
<help><![CDATA[
Font of data in column.
]]></help>
<values default="arial">
<value option="arial"/>
<value option="times"/>
<value option="courier"/>
<value option="arialunicodeMS"/>
</values>
</parameter>
<parameter name="fontsize" required="false" type="Numeric">
<help><![CDATA[
Size of text in column.
]]></help>
<values/>
</parameter>
<parameter name="fontitalic" required="false" type="boolean">
<help><![CDATA[
Yes: displays grid control text in italics
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="fontbold" required="false" type="boolean">
<help><![CDATA[
Yes: displays grid control text in bold
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="labelformat" required="false" type="String">
<help><![CDATA[
Format for Y-axis labels.
]]></help>
<values default="number">
<value option="number"/>
<value option="currency"/>
<value option="percent"/>
<value option="date"/>
</values>
</parameter>
<parameter name="xaxistitle" required="false" type="String">
<help><![CDATA[
text; X-axis title
]]></help>
<values/>
</parameter>
<parameter name="yaxistitle" required="false" type="String">
<help><![CDATA[
text; X-axis title
]]></help>
<values/>
</parameter>
<parameter name="xaxistype" required="false" type="String">
<help><![CDATA[
* category The axis indicates the data category. Data is
sorted according to the sortXAxis attribute.
* scale The axis is numeric. All cfchartdata item attribute
values must numeric. The X axis is automatically sorted
numerically.
]]></help>
<values default="category">
<value option="category"/>
<value option="scale"/>
</values>
</parameter>
<parameter name="yaxistype" required="false" type="String">
<help><![CDATA[
Currently has no effect, as Y axis is always used for data
values. Valid values are category and scale
]]></help>
<values default="category">
<value option="category"/>
<value option="scale"/>
</values>
</parameter>
<parameter name="sortxaxis" required="false" type="boolean">
<help><![CDATA[
Display column labels in alphabetic order along X-axis.
Ignored if the xAxisType attribute is scale.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="show3d" required="false" type="boolean">
<help><![CDATA[
Display chart with three-dimensional appearance.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="xoffset" required="false" type="Numeric">
<help><![CDATA[
Applies if show3D="yes". Number of units by which to
display the chart as angled, horizontally
]]></help>
<values default="0.1"/>
</parameter>
<parameter name="yoffset" required="false" type="Numeric">
<help><![CDATA[
Applies if show3D="yes". Number of units by which to
display the chart as angled, horizontally.
]]></help>
<values default="0.1"/>
</parameter>
<parameter name="showlegend" required="false" type="boolean">
<help><![CDATA[
yes: if chart contains more than one data series, display
legend
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="tipstyle" required="false" type="String">
<help><![CDATA[
Determines the action that opens a popup window to display
information about the current chart element.
* mouseDown: display if the user positions the cursor at the element
and clicks the mouse. Applies only to Flash format graph files.
* mouseOver: displays if the user positions the cursor at the element
* none: suppresses display
]]></help>
<values default="mouseOver">
<value option="mouseDown"/>
<value option="mouseOver"/>
<value option="none"/>
</values>
</parameter>
<parameter name="tipbgcolor" required="false" type="String">
<help><![CDATA[
color for control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values default="white">
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="showmarkers" required="false" type="boolean">
<help><![CDATA[
Applies to chartseries type attribute values line, curve
and scatter.
yes: display markers at data points
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="markersize" required="false" type="Numeric">
<help><![CDATA[
Size of data point marker. in pixels. Integer.
]]></help>
<values/>
</parameter>
<parameter name="pieslicestyle" required="false" type="String">
<help><![CDATA[
Applies to chartseries type attribute value pie.
]]></help>
<values default="sliced">
<value option="solid"/>
<value option="sliced"/>
</values>
</parameter>
<parameter name="URL" required="false" type="URL">
<!-- maybe should be string now? -->
<help><![CDATA[
URL to open if the user clicks item in a data series; the
onClick destination page.
You can specify variables within the URL string;
ColdFusion passes current values of the variables.
* $VALUE$: the value of the selected row. If none, the value is an empty string.
* $ITEMLABEL$: the label of the selected item. If none, the value is an empty string.
* $SERIESLABEL$: the label of the selected series. If none, the value is an empty string.
]]></help>
<values>
<value option="$VALUE$"/>
<value option="$ITEMLABEL$"/>
<value option="$SERIESLABEL$"/>
</values>
</parameter>
<parameter name="name" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
Page variable name. String. Generates the the graph as
binary data and assigns it to the specified variable.
Suppresses chart display. You can use the name value in
the cffile tag to write the chart to a file.
]]></help>
<values/>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
XML file or string to use to specify the style of the chart.
]]></help>
<values>
<value option="beige"/>
<value option="blue"/>
<value option="default"/>
<value option="red"/>
<value option="silver"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="title" required="false" type="String">
<help><![CDATA[
Title of the chart.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfchartdata
item = "text"
value = "number"
-->
<tag endtagrequired="false" name="cfchartdata" single="true"
xmlstyle="false">
<help><![CDATA[
Used with the cfchart and cfchartseries tags. This tag defines
chart data points. Its data is submitted to the cfchartseries
tag.
]]></help>
<parameter name="item" required="true" type="String">
<help><![CDATA[
string; data point name
]]></help>
<values/>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
number or expression; data point value
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfchartseries
type = "type"
query = "queryName"
itemColumn = "QueryColumn"
valueColumn = "QueryColumn"
seriesLabel = "Label Text"
seriesColor = "Hex value or Web color"
paintStyle = "plain, raise, shade, light"
markerStyle = "style"
colorlist = "list"
dataLabelStyle = "style"
/cfchartseries
-->
<tag endtagrequired="false" name="cfchartseries" single="true"
xmlstyle="false">
<help><![CDATA[
Used with the cfchart tag. This tag defines the style in which
chart data displays: bar, line, pie, and so on.
]]></help>
<parameter name="type" required="true" type="String">
<help><![CDATA[
Sets the chart display style
]]></help>
<values>
<value option="bar"/>
<value option="line"/>
<value option="pyramid"/>
<value option="area"/>
<value option="horizontalbar"/>
<value option="cone"/>
<value option="curve"/>
<value option="cylinder"/>
<value option="step"/>
<value option="scatter"/>
<value option="pie"/>
</values>
</parameter>
<parameter name="query" required="false" type="query">
<help><![CDATA[
Name of CFML query from which to get data.
]]></help>
<values/>
</parameter>
<parameter name="itemcolumn" required="false" type="String">
<help><![CDATA[
Name of a column in the query specified in the query
attribute; contains the item label for a data point to
graph.
]]></help>
<values/>
</parameter>
<parameter name="valuecolumn" required="false" type="String">
<help><![CDATA[
Name of a column in the query specified in the query
attribute; contains data values to graph.
]]></help>
<values/>
</parameter>
<parameter name="serieslabel" required="false" type="String">
<help><![CDATA[
Text of data series label
]]></help>
<values/>
</parameter>
<parameter name="seriescolor" required="false" type="String">
<help><![CDATA[
Color of the main element (such as the bars) of a chart.
For a pie chart, the color of the first slice.
Hex value or supported named color; see name list in the
cfchart Usage section.
For a hex value, use the form "##xxxxxx", where x = 0-9 or
A-F; use two pound signs or none.
]]></help>
<values/>
</parameter>
<parameter name="paintstyle" required="false" type="String">
<help><![CDATA[
Sets the paint display style of the data series.
]]></help>
<values default="plain">
<value option="plain"/>
<value option="raise"/>
<value option="shade"/>
<value option="light"/>
</values>
</parameter>
<parameter name="markerstyle" required="false" type="String">
<help><![CDATA[
Applies to chartseries type attribute values line, curve
and scatter, and show3D attribute value no.
]]></help>
<values default="rectangle">
<value option="rectangle"/>
<value option="triangle"/>
<value option="diamond"/>
<value option="circle"/>
<value option="letter"/>
<value option="mcross"/>
<value option="snow"/>
<value option="rcross"/>
</values>
</parameter>
<parameter name="colorlist" required="false" type="String">
<help><![CDATA[
Applies if chartseries type attribute = "pie". Sets pie
slice colors.
Comma-delimited list of hex values or supported, named web
colors; see name list in the cfchart Usage section.
For a hex value, use the form "##xxxxxx", where x = 0-9 or
A-F; use two pound signs or none.
]]></help>
<values/>
</parameter>
<parameter name="datalabelstyle" required="false" type="String">
<help><![CDATA[
Specifies the way in which the color is applied to the
item in the series:
- None = nothing is printed (default)
- Value = the value of the datapoint
- Rowlabel = the row's label
- Columnlabel = the column's label
- Pattern
]]></help>
<values>
<value option="none"/>
<value option="value"/>
<value option="rowlabel"/>
<value option="columnlabel"/>
<value option="pattern"/>
</values>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfcol
header = "column_header_text"
width = "number_indicating_width_of_column"
align = "Left" or "Right" or "Center"
text = "column_text"
-->
<tag endtagrequired="false" name="cfcol" single="true"
xmlstyle="false">
<help><![CDATA[
Defines table column header, width, alignment, and text. Used
within a cftable tag.
]]></help>
<parameter name="header" required="true" type="String">
<help><![CDATA[
Column header text. To use this attribute, you must also
use the cftable colHeaders attribute.
]]></help>
<values/>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Column width. If the length of data displayed exceeds this
value, data is truncated to fit. To avoid this, use an
HTML table tag.
]]></help>
<values default="20"/>
</parameter>
<parameter name="align" required="false" type="String">
<help><![CDATA[
Column alignment
]]></help>
<values default="left">
<value option="left"/>
<value option="center"/>
<value option="right"/>
</values>
</parameter>
<parameter name="text" required="true" type="String">
<help><![CDATA[
Double-quotation mark-delimited text; determines what to
display. Rules: same as for cfoutput sections. You can
embed hyperlinks, image references, and input controls
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="text">
<required>text</required>
<optional>align,header,width</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfcollection
action = "action"
collection = "collection_name"
path = "path_to_verity_collection"
language = "language"
name = "queryname"
categories = "true" or "false"
-->
<tag endtagrequired="false" name="cfcollection" single="true"
xmlstyle="false">
<help><![CDATA[
Creates, registers, and administers Verity search engine
collections.
A collection that is created with the cfcollection tag is
internal. A collection created any other way is external.
A collection that is registered with CFML using the
cfcollection tag or registered with the K2 Server by editing
the k2server.ini file is registered. Other collections are
unregistered.
]]></help>
<return parameter="name" type="query"/>
<parameter isswitchattribute="true" name="action"
required="true" type="String">
<help><![CDATA[
categorylist: retrieves categories from the collection and
indicates how many documents are in each one. Returns
a structure of structures in which the category
representing each substructure is associated with a
number of documents. For a category in a category tree,
the number of documents is the number at or below that
level in the tree.
create: registers the collection with CFML.
- If the collection is present: creates a map to it
- If the collection is not present: creates it
delete: unregisters a collection.
- If the collection was registered with action = create:
deletes its directories
- If the collection was registered and mapped: does not
delete collection directories
optimize: optimizes the structure and contents of the
collection for searching; recovers space.
list: returns a query result set, named from the name
attribute value, of the attributes of the collections
that are registered by CFML and K2 Server.
map: creates a map to the collection. It is not necessary
to specify this value. Deprecated in CF7.
repair: fixes data corruption in a collection. Deprecated in CF7.
]]></help>
<values default="list">
<value option="categorylist"/>
<value option="create"/>
<value option="delete"/>
<value option="optimize"/>
<value option="list"/>
<value deprecated="true" option="map"/>
<value deprecated="true" option="repair"/>
</values>
</parameter>
<parameter name="collection" required="false" type="String">
<help><![CDATA[
A collection name. The name can include spaces
]]></help>
<values/>
</parameter>
<parameter name="path" required="false" type="String">
<help><![CDATA[
Absolute path to a Verity/Lucene/SOLR collection.
]]></help>
<values/>
</parameter>
<parameter name="language" required="false" type="String">
<help><![CDATA[
Options are listed in Usage section. Requires the
appropriate (European or Asian) Verity Locales language
pack.
]]></help>
<values default="english"/>
</parameter>
<parameter name="name" required="false" returnVarType="query" type="String">
<help><![CDATA[
Name for the query results returned by the list action.
]]></help>
<values/>
</parameter>
<parameter name="categories" required="false" type="boolean">
<help><![CDATA[
Used only for creating a collection:
- true: This collection includes support for categories.
- false: This collection does not support categories. Default.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="engine" required="false" type="String">
<help><![CDATA[
Search engine
]]></help>
<values default="verity">
<value option="verity"/>
<value option="solr"/>
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="list">
<required>name</required>
<optional>engine</optional>
</combination>
<combination switchvalue="purge">
<required>collection</required>
<optional>language,path</optional>
</combination>
<combination switchvalue="create">
<required>collection,path</required>
<optional>categories,language,engine</optional>
</combination>
<combination switchvalue="categorylist">
<required>collection,name</required>
<optional>language,path</optional>
</combination>
<combination switchvalue="optimize">
<required>collection</required>
<optional>language,path</optional>
</combination>
<combination switchvalue="map">
<required>collection,path</required>
<optional>categories,language,engine</optional>
</combination>
<combination switchvalue="delete">
<required>collection</required>
<optional>language,path</optional>
</combination>
<combination switchvalue="repair">
<required>collection</required>
<optional>language,path</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfcomponent
extends ="anotherComponent"
output = "boolean"
displayname = "text string"
hint = "text string"
style = "rpc" or "document"
namespace = "default service namespace"
serviceportname = "port element name"
porttypename = "porttype element name"
bindingname = "binding element name"
wsdlfile = "path to hard-coded wsdl file">
[variable declarations cffunction ...]
/cfcomponent
-->
<tag allowanyattribute="true" canHaveAttributeCollection="false" endtagrequired="true"
name="cfcomponent" single="false"
xmlstyle="false">
<help><![CDATA[
Creates and defines a component object; encloses functionality
that you build in CFML and enclose within cffunction tags.
This tag contains one or more cffunction tags that define
methods. Code within the body of this tag, other than
cffunction tags, is executed when the component is
instantiated.
]]></help>
<parameter name="extends" required="false" type="String">
<help><![CDATA[
Name of parent component from which to inherit methods and
properties.
]]></help>
<values/>
</parameter>
<parameter name="initmethod" required="false" type="String">
<help><![CDATA[
Method that will be called when ColdFusion instantiates the component
]]></help>
<values/>
</parameter>
<parameter name="implements" required="false" type="String">
<help><![CDATA[
Name of the ColdFusion interface or interfaces
that this component implements. If the
component implements an interface, it must
define all the functions in the interface, and the
function definitions must conform to the
definitions specified in the interface. For more
information, see cfinterface.
A component can implement any number of
interfaces. To specify multiple interface, use a
comma delimited list, of the format
interface1,interface2.
]]></help>
<values/>
</parameter>
<parameter name="output" required="false" type="boolean">
<help><![CDATA[
Specifies whether constructor code in the component can
generate HTML output; does not affect output in the body
of cffunction tags in the component.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="displayname" required="false" type="String">
<help><![CDATA[
A string to be displayed when using introspection to show
information about the CFC. The information appears on the
heading, following the component name.
If the style attribute is set to document, the displayname
attribute is used as the name of the service element in the WSDL.
]]></help>
<values/>
</parameter>
<parameter name="hint" required="false" type="String">
<help><![CDATA[
Text to be displayed when using introspection to show
information about the CFC. The hint attribute value
appears below the component name heading. This attribute
can be useful for describing the purpose of the parameter.
If the style attribute is set to document, the hint
attribute is used as the document element of the service
in the WSDL.
]]></help>
<values/>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
Specifies whether a CFC used for web services uses
RPC-encoded style or document-literal style:
- rpc: RPC-encoded style, default
- document: Document-literal style
If you specify document, you must also specify the namespace,
serviceportname, porttypename, and bindingname attributes.
]]></help>
<values default="rpc">
<value option="rpc"/>
<value option="document"/>
</values>
</parameter>
<parameter name="namespace" required="false" type="String">
<help><![CDATA[
Specifies the namespace used in the WSDL when
using the CFC as a document-literal style web service.
If you don't specify this attribute, ColdFusion MX
derives the namespace from the CFC class name.
This attribute applies only when style="document".
]]></help>
<values/>
<triggers>
<selectedValue attributeName="sttyle"
required="false" value="document"/>
</triggers>
</parameter>
<parameter name="serviceportname" required="false" type="String">
<help><![CDATA[
Specifies the name of the port element in the WSDL.
This attribute applies only when style="document".
]]></help>
<values/>
<triggers>
<selectedValue attributeName="sttyle"
required="false" value="document"/>
</triggers>
</parameter>
<parameter name="porttypename" required="false" type="String">
<help><![CDATA[
Specifies the name of the porttype element in the WSDL.
This attribute applies only when style="document".
]]></help>
<values/>
<triggers>
<selectedValue attributeName="sttyle"
required="false" value="document"/>
</triggers>
</parameter>
<parameter name="bindingname" required="false" type="String">
<help><![CDATA[
Specifies the name of the binding element in the WSDL.
This attribute applies only when style="document".
]]></help>
<values/>
<triggers>
<selectedValue attributeName="sttyle"
required="false" value="document"/>
</triggers>
</parameter>
<parameter name="wsdlfile" required="false" type="String">
<help><![CDATA[
A properly formatted WSDL file to be used instead of
WSDL generated by ColdFusion MX.
This attribute applies only when style="document".
]]></help>
<values/>
<triggers>
<selectedValue attributeName="sttyle"
required="false" value="document"/>
</triggers>
</parameter>
<parameter name="serviceaddress" required="false" type="String">
<help><![CDATA[
Specifies the SOAP URL of the web service.
]]></help>
<values/>
</parameter>
<parameter name="persistent" required="false" type="boolean">
<help><![CDATA[
Specifies CFC is persistent or not
]]></help>
<values >
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="entityname" required="false" type="String">
<help><![CDATA[
Specifies the name of the entity. Entity name is the name used by the ORM related functions to work with the persistent CFC. If entityname is not specified, then the CFC name is taken as the entityname. The entityname must be unique in the application.
]]></help>
<values/>
</parameter>
<parameter name="table" required="false" type="String">
<help><![CDATA[
Specifies the name of the database table to which the CFC maps.
]]></help>
<values/>
</parameter>
<parameter name="schema" required="false" type="String">
<help><![CDATA[
Used to specify the schema name.
]]></help>
<values/>
</parameter>
<parameter name="catalog" required="false" type="String">
<help><![CDATA[
Used to specify the database catalog name.
]]></help>
<values/>
</parameter>
<parameter name="dynamicinsert" required="false" type="boolean">
<help><![CDATA[
Specifies whether INSERT SQL is to be generated at runtime.
Only those columns whose values are not null are included in the SQL.
]]></help>
<values default="false" >
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="dynamicupdate" required="false" type="boolean">
<help><![CDATA[
Specifies whether UPDATE SQL is to be generated at runtime.
Only those columns whose values are not null are included in the SQL.
]]></help>
<values default="false" >
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="readonly" required="false" type="boolean">
<help><![CDATA[
Specify whether table is readonly or not
]]></help>
<values >
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="selectbeforeupdate" required="false" type="boolean">
<help><![CDATA[
Specify whether Hibernate should never perform an SQL UPDATE unless it is certain that an object is actually modified.
In cases when a transient object is associated with a new session using update(), Hibernate performs an extra SQL SELECT to determine if an UPDATE is actually required.
]]></help>
<values >
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="batchsize" required="false" type="Numeric">
<help><![CDATA[
An integer value that specifies the number of records to be retrieved at a single instance.
]]></help>
<values/>
</parameter>
<parameter name="optimisticlock" required="false" type="String">
<help><![CDATA[
Determines the locking strategy.
It can be any one of the following four values:
none
version
dirty
all
]]></help>
<values default="version">
<value option="none"/>
<value option="dirty"/>
<value option="all"/>
<value option="version"/>
</values>
</parameter>
<parameter name="lazy" required="false" type="boolean">
<help><![CDATA[
Whether loading is to be done lazily or not.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="rowid" required="false" type="String">
<help><![CDATA[
Row id
]]></help>
<values/>
</parameter>
<parameter name="discriminatorColumn" required="false" type="String">
<help><![CDATA[
Use this attribute to define the discriminator column to be used in inheritance mapping
]]></help>
<values/>
</parameter>
<parameter name="discriminatorValue" required="false" type="String">
<help><![CDATA[
Use this attribute to define the discriminator value to be used in inheritance mapping
]]></help>
<values/>
</parameter>
<parameter name="joinColumn" required="false" type="String">
<help><![CDATA[
Use this attribute to define the join column for inheritance mapping.
]]></help>
<values/>
</parameter>
<parameter name="embedded" required="false" type="boolean">
<help><![CDATA[
Marks CFC as embeded
]]></help>
<values >
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="cacheUse" required="false" type="String">
<help><![CDATA[
Use this value to specify the caching strategy to be used for caching this component's data in the secondary cache
]]></help>
<values>
<value option="read-only" />
<value option="nonstrict-read-write" />
<value option="read-write" />
<value option="transactional" />
</values>
</parameter>
<parameter name="cacheName" required="false" type="String">
<help><![CDATA[
Use this value to specify the name of the secondary cache.
]]></help>
<values/>
</parameter>
<parameter name="saveMapping" required="false" type="boolean">
<help><![CDATA[
Specifies whether the generated Hibernate mapping file has to be saved to disk. If you set the value to true, the Hibernate mapping XML file is saved with the filename "CFC name".hbm.xml in the same directory as the CFC.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="accessors" required="false" type="boolean">
<help><![CDATA[
If set to false, ColdFusion ORM does not generate the implicit getters and setters.
]]></help>
<values >
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="serializable" required="false" type="Boolean">
<help><![CDATA[
Specifies whether this component can be serialized. If you set this value to false, the component and the data in the component’s This and Variables scopes cannot be serialized, so they are not retained on session replication, and the component is in its default state.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="attribute" required="false" type="Boolean">
<help><![CDATA[
If the attribute is set to “false” at the component level, then the implicit getters and setters for the individual properties are ignored.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</tag>
<!--
cfcontent
type = "file_type"
deleteFile = "boolean"
file = "filename"
reset = "boolean"
[starting with a drive letter and a colon, or a forward
or backward slash]
-->
<tag endtagrequired="false" name="cfcontent" single="true"
xmlstyle="false">
<help><![CDATA[
Does either or both of the following:
* Sets the MIME content encoding header for the current page
* Sends the contents of a file from the server as the page
output
]]></help>
<parameter name="type" required="false" type="String">
<help><![CDATA[
The MIME content type of the page, optionally followed by
a semicolon and the character encoding. By default,
CFML sends pages as text/html content type in
the UTF-8 character encoding.
]]></help>
<values>
<value option="text/html"/>
<value option="text/plain"/>
<value option="application/msword"/>
<value option="application/msexcel"/>
<value option="application/poscript"/>
<value option="application/x-zip-compressed"/>
<value option="application/pdf"/>
<value option="application/rtf"/>
<value option="video/x-msvideo"/>
<value option="video/quicktime"/>
<value option="video/x-mpeg2"/>
<value option="audio/x-pn/realaudio"/>
<value option="audio/x-mpeg"/>
<value option="audio/x-waw"/>
<value option="audio/x-aiff"/>
<value option="audio/basic"/>
<value option="image/tiff"/>
<value option="image/jpeg"/>
<value option="image/gif"/>
<value option="image/x-png"/>
<value option="image/x-photo-cd"/>
<value option="image/x-MS-bmp"/>
<value option="image/x-rgb"/>
<value option="image/x-portable-pixmap"/>
<value option="image/x-portable-greymap"/>
<value option="image/x-portablebitmap"/>
</values>
</parameter>
<parameter name="deletefile" required="false" type="boolean">
<help><![CDATA[
Applies only if you specify a file with the file attribute.
Yes: deletes the file on the server after sending its
contents to the client.
No: leaves the file on the server.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="file" required="false" type="String">
<help><![CDATA[
Name of file whose contents will be the page output. When
using CFML in a distributed configuration, the file
attribute must refer to a path on the system on which the
web server runs. When you use this attribute, any other
output on the current CFML page is ignored; only the
contents of the file is sent to the client.
]]></help>
<values/>
</parameter>
<parameter name="variable" required="false" returnVarType="variablename" type="String">
<!-- VariableName -->
<help><![CDATA[
Name of a ColdFusion MX binary variable whose contents can
be displayed by the browser, such as the contents of a chart
generated by the cfchart tag or a PDF or Excel file
retrieved by a cffile action="readBinary" tag.
When you use this attribute, any other output on the current
CFML page is ignored; only the contents of the file are sent
to the client.
]]></help>
<values/>
</parameter>
<parameter name="reset" required="false" type="boolean">
<help><![CDATA[
The reset and file attributes are mutually exclusive.
If you specify a file, this attribute has no effect.
Yes: discards output that precedes call to cfcontent
No: preserves output that precedes call to cfcontent. In
this case all output is sent with the specified type.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfcookie
name = "cookie_name"
value = "text"
expires = "period"
secure = "boolean"
path = "URL"
domain = ".domain"
-->
<tag endtagrequired="false" name="cfcookie" single="true"
xmlstyle="false">
<help><![CDATA[
Defines web browser cookie variables, including expiration and
security options.
]]></help>
<return parameter="name" type="String"/>
<parameter name="name" required="true" returnVarType="variablename" type="String">
<help><![CDATA[
Name of cookie variable. CFML converts cookie names
to all-uppercase. Cookie names set using this tag can
include any printable ASCII characters except commas,
semicolons or white space characters.
]]></help>
<values/>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
Value to assign to cookie variable. Must be a string or
variable that can be stored as a string.
]]></help>
<values/>
</parameter>
<parameter name="expires" required="false" type="Object">
<help><![CDATA[
Expiration of cookie variable.
* The default: the cookie expires when the user closes the
browser, that is, the cookie is "session only".
* A date or date/time object (for example, 10/09/97)
* A number of days (for example, 10, or 100)
* now: deletes cookie from client cookie.txt file
(but does not delete the corresponding variable the
Cookie scope of the active page).
* never: The cookie expires in 30 years from the time it
was created (effectively never in web years).
]]></help>
<values/>
</parameter>
<parameter name="secure" required="false" type="boolean">
<help><![CDATA[
If browser does not support Secure Sockets Layer (SSL)
security, the cookie is not sent. To use the cookie, the
page must be accessed using the https protocol.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="path" required="false" type="String">
<help><![CDATA[
URL, within a domain, to which the cookie applies;
typically a directory. Only pages in this path can use the
cookie. By default, all pages on the server that set the
cookie can access the cookie.
path = "/services/login"
]]></help>
<values/>
</parameter>
<parameter name="domain" required="false" type="String">
<help><![CDATA[
Domain in which cookie is valid and to which cookie content
can be sent from the user's system. By default, the cookie
is only available to the server that set it. Use this
attribute to make the cookie available to other servers.
Must start with a period. If the value is a subdomain, the
valid domain is all domain names that end with this string.
This attribute sets the available subdomains on the site
upon which the cookie can be used.
]]></help>
<values/>
</parameter>
<parameter name="httpOnly" required="false" type="Boolean">
<help><![CDATA[
Specify whether coockie is http coockie or not
]]></help>
<values >
<value option="true" />
<value option="false" />
</values>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>domain,expires,secure,value,httponly</optional>
</combination>
<combination attributename="name">
<required>domain,name,path</required>
<optional>expires,secure,value,httponly</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfdbinfo
-->
<tag endtagrequired="false" name="cfdbinfo" single="true"
xmlstyle="false">
<help><![CDATA[
Lets you retrieve information about a data source, including details about the database, tables, queries, procedures, foreign keys, indexes, and version information about the database, driver, and JDBC
]]></help>
<return parameter="name" type="query" />
<parameter isswitchattribute="true" name="type"
required="true" type="String">
<help><![CDATA[
Type of information to get:
* dbnames: database name and type
* tables: name, type, and remarks
* columns: name, SQL data type, size, decimal precision, default value, maximum length in bytes of a character or integer data type column, whether nulls are allowed, ordinal position, remarks, whether the column is a primary key, whether the column is a foreign key, the table that the foreign key refers to, the key name the foreign key refers to
* version: database product name and version, driver name and version, JDBC major and minor version
* procedures: name, type, and remarks
* foreignkeys: foreign key name and table, primary key name, delete and update rules
* index: name, column on which the index is applied, ordinal position, cardinality, whether the row represents a table statistic or an index, number of pages used by the table or index, whether the index values are unique
]]></help>
<values default="Tables">
<value option="Columns"/>
<value option="DBNames"/>
<value option="Tables"/>
<value option="Foreignkeys"/>
<value option="Index"/>
<value option="Procedures"/>
<value option="Version"/>
</values>
</parameter>
<parameter name="datasource" returnVarType="variablename" required="false" type="String">
<help><![CDATA[
Datasource to use to connect to the database.
]]></help>
<values/>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Name to use to refer to the result.
]]></help>
<values/>
</parameter>
<parameter name="dbname" required="false" type="String">
<help><![CDATA[
Name of the database.
]]></help>
<values/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
User name to connect to the database.
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Password to connect to the database.
]]></help>
<values/>
</parameter>
<parameter name="pattern" required="false" type="String">
<help><![CDATA[
Used only if type = "tables" ,type = "columns" , or type = "procedures"
. Specifies a filter to retrieve information about specific tables, columns, or stored procedures. Use an underline (_) to represent a single wildcard character and a percent sign (%) to represent a wildcard of zero or more characters.
]]></help>
<values/>
</parameter>
<parameter name="table" required="false" type="String">
<help><![CDATA[
Name of the table from which you retrieve information.
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination switchvalue="index">
<required>name,table</required>
<optional>datasource,dbname,password,username</optional>
</combination>
<combination switchvalue="dbnames">
<required>name</required>
<optional>datasource,dbname,password,username</optional>
</combination>
<combination switchvalue="tables">
<required>name</required>
<optional>datasource,dbname,password,pattern,username</optional>
</combination>
<combination switchvalue="columns">
<required>name,table</required>
<optional>datasource,dbname,password,pattern,username</optional>
</combination>
<combination switchvalue="procedures">
<required>name</required>
<optional>datasource,dbname,password,pattern,username</optional>
</combination>
<combination switchvalue="foreignkeys">
<required>name,table</required>
<optional>datasource,dbname,password,username</optional>
</combination>
<combination switchvalue="version">
<required>name</required>
<optional>datasource,dbname,password,username</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfdefaultcase
...
/cfdefaultcase
-->
<tag endtagrequired="true" canHaveAttributeCollection="false" name="cfdefaultcase" single="false"
xmlstyle="false">
<help><![CDATA[
Used only inside the cfswitch tag body. Contains code to
execute when the expression specified in the cfswitch tag does
not match any of the values specified by preceeding cfcase tags.
]]></help>
</tag>
<!--
cfdirectory
action = "directory action"
directory = "directory name"
name = "query name"
filter = "list filter"
mode = "permission"
sort = "sort specification"
newDirectory = "new directory name"
recurse = "true" or "false"
-->
<tag endtagrequired="false" name="cfdirectory" single="true"
xmlstyle="false">
<help><![CDATA[
Manages interactions with directories.
Different combos cause different attributes to be
required.
]]></help>
<return parameter="name" type="query"/>
<parameter isswitchattribute="true" name="action"
required="false" type="String">
<help><![CDATA[
Action to perform
]]></help>
<values default="list">
<value option="list"/>
<value option="create"/>
<value option="delete"/>
<value option="rename"/>
</values>
</parameter>
<parameter name="directory" required="true" type="String">
<help><![CDATA[
Absolute pathname of directory against which to perform
action.
]]></help>
<values/>
</parameter>
<parameter name="name" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
Name for output record set.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="list"/>
</triggers>
</parameter>
<parameter name="filter" required="false" type="String">
<help><![CDATA[
File extension filter applied to returned names. For
example: *.cfm. One filter can be applied.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="list"/>
</triggers>
</parameter>
<parameter name="mode" required="false" type="String">
<help><![CDATA[
Applies only to UNIX and Linux. Permissions. Octal values
of Unix chmod command. Assigned to owner, group, and
other, respectively.
]]></help>
<values/>
</parameter>
<parameter name="sort" required="false" type="String">
<help><![CDATA[
Query column(s) by which to sort directory listing.
Delimited list of columns from query output.
]]></help>
<values default="asc">
<value option="asc"/>
<value option="desc"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="list"/>
</triggers>
</parameter>
<parameter name="newdirectory" required="false" type="String">
<help><![CDATA[
New name for directory.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="rename"/>
</triggers>
</parameter>
<parameter name="recurse" required="false" type="boolean">
<help><![CDATA[
Whether ColdFusion performs the action on subdirectories.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="list"/>
<selectedValue attributeName="action"
required="false" value="delete"/>
</triggers>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
* file: includes only filenames.
* dir: includes only directory names.
* all: includes both filenames and directory names.
]]></help>
<values default="all">
<value option="dir"/>
<value option="file"/>
<value option="all"/>
</values>
</parameter>
<parameter name="listinfo" required="false" type="String">
<help><![CDATA[
* all: includes all information in the result set.
* name: includes only filenames in the result set.
]]></help>
<values default="all">
<value option="name"/>
<value option="all"/>
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="rename">
<required>directory,newdirectory</required>
<optional/>
</combination>
<combination switchvalue="list">
<required>directory,name</required>
<optional>action,filter,listinfo,recurse,sort,type</optional>
</combination>
<combination switchvalue="create">
<required>directory</required>
<optional>mode</optional>
</combination>
<combination switchvalue="delete">
<required>directory</required>
<optional>recurse</optional>
</combination>
</possiblecombinations>
</tag>
<!--
<cfdiv
required
source = "path"
optional
ID = "HTML tag ID"
onBindError = "JavaScript function name"
tagName = "HTML tag name"
standard HTML tags
/>
-->
<tag endtagrequired="false" name="cfdiv" single="true"
xmlstyle="true">
<help><![CDATA[
Creates an HTML tag with specified contents and lets you to use bind expressions to
dynamically control the tag contents.
]]></help>
<parameter name="id" required="false" type="String">
<help><![CDATA[
The HTML ID attribute value to assign to the
generated container tag.
]]></help>
</parameter>
<parameter name="onBindError" required="false" type="String">
<help><![CDATA[
The name of a JavaScript function to execute if
evaluating a bind expression results in an error. The
function must take two attributes: an HTTP status
code and a message.
If you omit this attribute, and have specified a
global error handler (by using the
ColdFusion.setGlobalErrorHandler function), it
displays the error message; otherwise a default
error pop-up displays.
]]></help>
<values/>
</parameter>
<parameter name="bind" required="false" type="String">
<help><![CDATA[
A bind expression that returns the container
contents.
Note: If a CFML page specified in this attribute
contains tags that use AJAX features, such as
cfform, cfgrid, and cfwindow, you must use a
tag on the page with the tag.
For more information, see cfajaximport.
]]></help>
</parameter>
<parameter name="tagName" required="false" type="String">
<help><![CDATA[
The HTML container tag to create.
]]></help>
<values default="div">
<value option="div"/>
<value option="span"/>
</values>
</parameter>
<parameter name="bindonload" required="false" type="Boolean">
<help><![CDATA[
* true: executes the bind attribute expression when first loading the tag.
* false: does not execute the bind attribute expression until the first bound event .
To use this attribute, you must also specify a bind attribute.
]]></help>
<values default="true">
<value option="false"/>
<value option="true"/>
</values>
</parameter>
<possiblecombinations/>
</tag>
<tag endtagrequired="true" name="cfdocument" single="false"
xmlstyle="true">
<help><![CDATA[
Creates PDF or FlashPaper output from a text block containing CFML and HTML.
]]></help>
<return parameter="name" type="variablename" />
<parameter name="format" required="true" type="String">
<help><![CDATA[
Specifies the report format.
]]></help>
<values>
<value option="PDF"/>
<value option="FlashPaper"/>
</values>
</parameter>
<parameter name="filename" required="false" type="String">
<help><![CDATA[
Specifies the fully qualified path name of a file to
contain the PDF or FlashPaper output. If you omit the
filename attribute, ColdFusion MX streams output to
the browser.
]]></help>
<values/>
</parameter>
<parameter name="localurl" required="false" type="boolean">
<help><![CDATA[
Specifies whether to retrieve image files directly
from the local drive:
* yes: ColdFusion retrieves image files directly from
the local drive rather than by using HTTP, HTTPS, or proxy.
* no: ColdFusion uses HTTP, HTTPS, or proxy to retrieve
image files even if the files are stored locally.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="overwrite" required="false" type="boolean">
<help><![CDATA[
Specifies whether ColdFusion MX overwrites an
existing file. Used in conjunction with filename.
Default is: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="name" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
Specifies the name of an existing variable into which
the tag stores the PDF or FlashPaper output.
]]></help>
<values/>
</parameter>
<parameter name="pagetype" required="false" type="String">
<help><![CDATA[
Specifies the page size into which ColdFusion
generates the report.
- legal: 8.5 inches x 14 inches
- letter: 8.5 inches x 11 inches
- A4: 8.27 inches x 11.69 inches
- A5: 5.81 inches x 8.25 inches
- B5: 9.81 inches x 13.88 inches
- Custom: Custom height and width.
If you specify custom, you must also specify the pageheight
and pagewidth attributes, can optionally specify margin
attributes, and can optionally specify whether the units
are inches or centimeters.
]]></help>
<values default="A4">
<value option="legal"/>
<value option="letter"/>
<value option="A4"/>
<value option="A5"/>
<value option="B5"/>
<value option="custom"/>
</values>
</parameter>
<parameter name="pageheight" required="false" type="Numeric">
<help><![CDATA[
Specifies the page height in inches (default) or
centimeters. This attribute is only valid if
pagetype=custom. To specify page height in
centimeters, include the unit=cm attribute.
]]></help>
<values/>
</parameter>
<parameter name="pagewidth" required="false" type="Numeric">
<help><![CDATA[
Specifies the page width in inches (default) or
centimeters. This attribute is only valid if
pagetype=custom. To specify page width in
centimeters, include the unit=cm attribute.
]]></help>
<values/>
</parameter>
<parameter name="orientation" required="false" type="String">
<help><![CDATA[
Specifies the page orientation. Specify either of the
following:
- portrait (default)
- landscape
]]></help>
<values default="portrait">
<value option="portrait"/>
<value option="landscape"/>
</values>
</parameter>
<parameter name="margintop" required="false" type="Numeric">
<help><![CDATA[
Specifies the top margin in inches (default) or
centimeters. To specify top margin in centimeters,
include the unit=cm attribute.
]]></help>
<values/>
</parameter>
<parameter name="marginbottom" required="false" type="String">
<help><![CDATA[
Specifies the bottom margin in inches (default) or
centimeters. To specify bottom margin in
centimeters, include the unit=cm attribute.
]]></help>
<values/>
</parameter>
<parameter name="marginleft" required="false" type="String">
<help><![CDATA[
Specifies the left margin in inches (default) or
centimeters. To specify left margin in centimeters,
include the unit=cm attribute.
]]></help>
<values/>
</parameter>
<parameter name="marginright" required="false" type="String">
<help><![CDATA[
Specifies the right margin in inches (default) or
centimeters. To specify right margin in centimeters,
include the unit=cm attribute.
]]></help>
<values/>
</parameter>
<parameter name="unit" required="false" type="String">
<help><![CDATA[
Specifies the default unit (inches or centimeters) for
pageheight, pagewidth, and margin attributes.
]]></help>
<values default="in">
<value option="in"/>
<value option="cm"/>
</values>
</parameter>
<parameter name="encryption" required="false" type="String">
<help><![CDATA[
Specifies whether the output is encrypted (format="PDF" only).
Default is: none
]]></help>
<values default="none">
<value option="128-bit"/>
<value option="40-bit"/>
<value option="none"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="pdf"/>
</triggers>
</parameter>
<parameter name="ownerpassword" required="false" type="String">
<help><![CDATA[
Specifies an owner password (format="PDF" only).
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="pdf"/>
</triggers>
</parameter>
<parameter name="userpassword" required="false" type="String">
<help><![CDATA[
Specifies a user password (format="PDF" only).
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="pdf"/>
</triggers>
</parameter>
<parameter name="permissions" required="false" type="String">
<help><![CDATA[
Specifies one or more permissions (format="PDF" only).
Separate multiple permissions with a comma.
]]></help>
<values>
<value option="AllowPrinting,AllowCopy,AllowScreenReaders"/>
<value option="AllowPrinting"/>
<value option="AllowModifyContents"/>
<value option="AllowCopy"/>
<value option="AllowModifyAnnotations"/>
<value option="AllowFillIn"/>
<value option="AllowScreenReaders"/>
<value option="AllowAssembly"/>
<value option="AllowDegradedPrinting"/>
<value option="AllowPrinting,AllowModifyContents,AllowCopy,AllowModifyAnnotations,AllowFillIn,AllowScreenReaders,AllowAssembly,AllowDegradedPrinting"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="pdf"/>
</triggers>
</parameter>
<parameter name="fontembed" required="false" type="boolean">
<help><![CDATA[
Specifies whether ColdFusion embeds fonts in the output.
Specify one of the following:
- true: Embed fonts
- false: Do not embed fonts.
Selective: Embed all fonts except Java fonts and core fonts.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="backgroundvisible" required="false" type="boolean">
<help><![CDATA[
Specifies whether the background prints when the
user prints the document:
- yes: include the background when printing.
- no: do not include the background when printing.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="scale" required="false" type="Numeric">
<help><![CDATA[
Specifies a scale factor as a percentage. Use this
option to reduce the size of the HTML output so that
it fits on that paper. Specify a number less than 100.
]]></help>
<values>
<value option="100"/>
<value option="90"/>
<value option="80"/>
<value option="70"/>
<value option="60"/>
<value option="50"/>
<value option="40"/>
<value option="30"/>
<value option="20"/>
<value option="10"/>
</values>
</parameter>
<parameter name="authpassword" required="false" type="String">
<help><![CDATA[
Password sent to the target URL for Basic Authentication.
Combined with username to form a base64 encoded string that is passed in the Authenticate header.
Does not provide support for Integrated Windows, NTLM, or Kerebos authentication.
]]></help>
</parameter>
<parameter name="authuser" required="false" type="String">
<help><![CDATA[
User name sent to the target URL for Basic Authentication.
Combined with password to form a base64 encoded string that is passed in the Authenticate header.
Does not provide support for Integrated Windows, NTLM, or Kerebos authentication.
]]></help>
</parameter>
<parameter name="bookmark" required="false" type="Boolean">
<help><![CDATA[
Specifies whether bookmarks are created in the document:
* yes: creates bookmarks.
* no: does not create bookmarks.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="localurl" required="false" type="Boolean">
<help><![CDATA[
Specifies whether to retrieve image files directly from the local drive:
* yes: ColdFusion retrieves image files directly from the local drive rather than by using HTTP, HTTPS, or proxy.
* no: ColdFusion uses HTTP, HTTPS, or proxy to retrieve image files even if the files are stored locally.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="mimetype" required="false" type="String">
<help><![CDATA[
MIME type of the source document
]]></help>
<values default="text/html">
<value option="text/html"/>
<value option="text/plain"/>
<value option="application/xml"/>
<value option="image/bmp"/>
<value option="image/jpeg"/>
<value option="image/png"/>
<value option="image/gif"/>
</values>
</parameter>
<parameter name="proxypassword" required="false" type="String">
<help><![CDATA[
Password required by the proxy server.
]]></help>
</parameter>
<parameter name="proxyuser" required="false" type="String">
<help><![CDATA[
User name to provide to the proxy server.
]]></help>
</parameter>
<parameter name="saveasname" required="false" type="String">
<help><![CDATA[
(format="PDF" only) The filename that appears in the SaveAs dialog when a user saves a PDF file written to the browser.
]]></help>
</parameter>
<parameter name="src" required="false" type="String">
<help><![CDATA[
URL or the relative path to the web root. You cannot specify both the src and srcfile attributes.
The file must be in a browser-writable format such as, HTML, HTM, BMP, PNG, and so on.
]]></help>
</parameter>
<parameter name="srcfile" required="false" type="String">
<help><![CDATA[
Absolute path of a file that is on the server. You cannot specify both the src and srcfile attributes.
The file must be in a browser-writable format such as, HTML, HTM, BMP, PNG, and so on.
]]></help>
</parameter>
<parameter name="useragent" required="false" type="String">
<help><![CDATA[
Text to put in the HTTP User-Agent request header field. Used to identify the request client software.
]]></help>
</parameter>
<parameter name="proxyhost" required="false" type="String">
<help><![CDATA[
IP address or server name for proxy host.
]]></help>
</parameter>
<parameter name="proxyport" required="false" type="String">
<help><![CDATA[
port of the proxy host.
]]></help>
</parameter>
<parameter name="tagged" required="false" type="Boolean">
<help><![CDATA[
Determines if PDF are created by using special tags also known as Tagged PDF
]]></help>
<values default="false">
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="pdfa" required="false" type="Boolean">
<help><![CDATA[
Creates a PDF of type PDF/A-1 (ISO 19005-1:2005)
]]></help>
<values default="false">
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="formFields" required="false" type="Boolean">
<help><![CDATA[
Specifies whether form fields are exported as widgets or only their fixed print representation is exported.
]]></help>
<values default="true">
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="formsType" required="false" type="String">
<help><![CDATA[
Specifies the submitted format of a PDF form.
]]></help>
<values default="FDF">
<value option="FDF" />
<value option="PDF" />
<value option="HTML" />
<value option="XML" />
</values>
</parameter>
<parameter name="permissionsPassword" required="false" type="String">
<help><![CDATA[
This is the password that allows the user to access some permissions restricted if some permissions need to be restricted. The permissions are defined in "permissions" attribute
]]></help>
</parameter>
<parameter name="openPassword" required="false" type="String">
<help><![CDATA[
If the source document is protected specify using this attribute.
]]></help>
</parameter>
<possiblecombinations>
<combination attributename="format">
<required>format</required>
<optional>authpassword,authuser,backgroundvisible,bookmark,encryption,filename,fontembed,localurl,marginbottom,marginleft,marginright,margintop,mimetype,name,orientation,overwrite,ownerpassword,pageheight,pagetype,pagewidth,permissions,printallframes,proxyhost,proxypassword,proxyport,proxyuser,saveasname,scaletofit,scale,scaletofit,src,unit,useragent,userpassword,tagged,pdfa,formFields,formsType,permissionsPassowrd,openPassword</optional>
</combination>
<combination attributename="format">
<required>format</required>
<optional>authpassword,authuser,backgroundvisible,bookmark,encryption,filename,fontembed,localurl,marginbottom,marginleft,marginright,margintop,mimetype,name,orientation,overwrite,ownerpassword,pageheight,pagetype,pagewidth,permissions,printallframes,proxyhost,proxypassword,proxyport,proxyuser,saveasname,scaletofit,scale,scaletofit,srcfile,unit,useragent,userpassword,tagged,pdfa,formFields,formsType,permissionsPassowrd,openPassword</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfdocument ...
Syntax 1
cfdocumentitem type = "pagebreak" /
Syntax 2
cfdocumentitem
type = "header" or "footer"
header/footer text
/cfdocumentitem
/cfdocument
-->
<tag endtagrequired="true" name="cfdocumentitem" single="false"
xmlstyle="true">
<help><![CDATA[
Specifies action items for a PDF or FlashPaper document
created by the cfdocument tag.
]]></help>
<parameter name="type" required="true" type="String">
<help><![CDATA[
Specifies the action:
- pagebreak: start a new page at the location of the tag.
- header: use the text between the <cfdocumentitem>
and </cfdocumentitem> tags as the running header.
- footer: use the text between the <cfdocumentitem>
and </cfdocumentitem> tags as the running footer.
]]></help>
<values>
<value option="pagebreak"/>
<value option="header"/>
<value option="footer"/>
</values>
</parameter>
<parameter name="evalAtPrint" required="false" type="Boolean">
<help><![CDATA[
Specifies whether to evaluate expressions inside cfdocumentitem tag at runtime.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations>
<combination attributename="type">
<required>type</required>
<optional/>
</combination>
</possiblecombinations>
</tag>
<!--
cfdocument ...
cfdocumentsection
margintop = "number"
marginbottom = "number"
marginleft = "number"
marginright = "number"
HTML, CFML, and cfdocumentitem tags
/cfdocumentsection
/cfdocument
-->
<tag endtagrequired="true" name="cfdocumentsection"
single="false"
xmlstyle="true">
<help><![CDATA[
Divides a PDF or FlashPaper document into sections.
By using this tag in conjunction with a cfdocumentitem
tag, each section can have unique headers, footers,
and page numbers.
]]></help>
<parameter name="margintop" required="false" type="Numeric">
<help><![CDATA[
Specifies the top margin in inches (default) or
centimeters. To specify the top margin in centimeters,
include the unit="cm" attribute in the parent cfdocument
tag.
]]></help>
<values/>
</parameter>
<parameter name="marginbottom" required="false" type="Numeric">
<help><![CDATA[
Specifies the bottom margin in inches (default) or
centimeters. To specify the bottom margin in
centimeters, include the unit="cm" attribute in the
parent cfdocument tag.
]]></help>
<values/>
</parameter>
<parameter name="marginleft" required="false" type="Numeric">
<help><![CDATA[
Specifies the left margin in inches (default) or
centimeters. To specify the left margin in centimeters,
include the unit="cm" attribute in the parent cfdocument
tag.
]]></help>
<values/>
</parameter>
<parameter name="marginright" required="false" type="Numeric">
<help><![CDATA[
Specifies the right margin in inches (default) or
centimeters. To specify the right margin in centimeters,
include the unit="cm" attribute in the parent cfdocument
tag.
]]></help>
<values/>
</parameter>
<parameter name="authpassword" required="false" type="String">
<help><![CDATA[
Password sent to the target URL for Basic Authentication.
Combined with username to form a base64 encoded string that is passed in the Authenticate header.
Does not provide support for Integrated Windows, NTLM, or Kerebos authentication.
]]></help>
</parameter>
<parameter name="authuser" required="false" type="String">
<help><![CDATA[
User name sent to the target URL for Basic Authentication.
Combined with password to form a base64 encoded string that is passed in the Authenticate header.
Does not provide support for Integrated Windows, NTLM, or Kerebos authentication.
]]></help>
</parameter>
<parameter name="mimetype" required="false" type="String">
<help><![CDATA[
MIME type of the source document
]]></help>
<values default="text/html">
<value option="text/html"/>
<value option="text/plain"/>
<value option="application/xml"/>
<value option="image/bmp"/>
<value option="image/jpeg"/>
<value option="image/png"/>
<value option="image/gif"/>
</values>
</parameter>
<parameter name="name" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
Bookmark name for the section.
]]></help>
</parameter>
<parameter name="src" required="false" type="String">
<help><![CDATA[
URL or the relative path to the web root. You cannot specify both the src and srcfile attributes.
]]></help>
</parameter>
<parameter name="srcfile" required="false" type="String">
<help><![CDATA[
Absolute path of a file that is on the server.
You cannot specify both the src and srcfile attributes.
]]></help>
</parameter>
<parameter name="useragent" required="false" type="String">
<help><![CDATA[
Text to put in the HTTP User-Agent request header field. Used to identify the request client software.
]]></help>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfdump
var = "#variable#"
expand = "boolean"
label = "text"
-->
<tag endtagrequired="false" name="cfdump" single="true"
xmlstyle="false">
<help><![CDATA[
Outputs the elements, variables and values of most kinds of
CFML objects. Useful for debugging. You can display the
contents of simple and complex variables, objects, components,
user-defined functions, and other elements.
]]></help>
<parameter name="var" required="true" type="variablename">
<help><![CDATA[
Variable to display. Enclose a variable name in pound
signs.
]]></help>
<values/>
</parameter>
<parameter name="expand" required="false" type="boolean">
<help><![CDATA[
Yes: In Internet Explorer and Mozilla, expands views
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="format" required="false" type="String">
<help><![CDATA[
specify whether to save the results of a cfdump to a file in text or HTML format
]]></help>
<values default="text">
<value option="html"/>
<value option="text"/>
</values>
</parameter>
<parameter name="hide" required="false" type="String">
<help><![CDATA[
hide column or keys.
]]></help>
<values/>
</parameter>
<parameter name="keys" required="false" type="Numeric">
<help><![CDATA[
For a structure, number of keys to display.
]]></help>
<values/>
</parameter>
<parameter name="label" required="false" type="String">
<help><![CDATA[
A string; header for the dump output.
]]></help>
<values/>
</parameter>
<parameter name="metainfo" required="false" type="boolean">
<help><![CDATA[
Includes information about the query in the cfdump results.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="output" required="false" type="String">
<help><![CDATA[
Where to send the results of cfdump.
]]></help>
<values default="browser">
<value option="browser"/>
<value option="console"/>
<value option="filename"/>
</values>
</parameter>
<parameter name="show" required="false" type="String">
<help><![CDATA[
show column or keys.
]]></help>
<values/>
</parameter>
<parameter name="showUDfs" required="false" type="boolean">
<help><![CDATA[
show UDFs in cfdump output.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="top" required="false" type="Numeric">
<help><![CDATA[
The number of rows to display.
]]></help>
<values/>
</parameter>
<parameter name="abort" required="false" type="boolean">
<help><![CDATA[
stops further processing of page
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations>
<combination attributename="var">
<required>var</required>
<optional>label</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfelse
-->
<tag endtagrequired="false" canHaveAttributeCollection="false" name="cfelse" single="true"
xmlstyle="false">
<help><![CDATA[
Used as the last control block in a cfif tag block to handle
any case not identified by the cfif tag or a cfelseif tag.
]]></help>
</tag>
<!--
cfelseif
expression
-->
<tag endtagrequired="false" canHaveAttributeCollection="false" name="cfelseif" single="true"
xmlstyle="false">
<help><![CDATA[
Used as a control block in a cfif tag block to handle any case
not identified by the cfif tag or a cfelseif tag.
]]></help>
</tag>
<!--
cferror
type = "a type"
template = "template_path"
mailTo = "email_address"
exception = "exception_type"
-->
<tag endtagrequired="false" name="cferror" single="true"
xmlstyle="false">
<help><![CDATA[
Displays a custom HTML page when an error occurs. This lets
you maintain a consistent look and feel among an application's
functional and error pages
]]></help>
<parameter name="type" required="true" type="String">
<help><![CDATA[
Type of error that the custom error page handles. The type
also determines how CFML handles the error page. For
more information, see Specifying a custom error page in
Developing CFML MX Applications.
exception: a exception of the type specified by the
exception attribute.
validation: errors recognized by sever-side type
validation.
request: any encountered error.
monitor: deprecated.
]]></help>
<values>
<value option="exception"/>
<value option="validation"/>
<value option="request"/>
<value deprecated="true" option="monitor"/>
</values>
</parameter>
<parameter name="template" required="true" type="String">
<help><![CDATA[
Relative path to the custom error page.
(A CFML page was formerly called a template.)
]]></help>
<values/>
</parameter>
<parameter name="mailto" required="false" type="String">
<help><![CDATA[
An E-mail address. This attribute is available on the
error page as the variable error.mailto. CFML does
not automatically send anything to this address.
]]></help>
<values/>
</parameter>
<parameter name="exception" required="false" type="String">
<help><![CDATA[
Type of exception that the tag handles:
application: application exceptions
database: database exceptions
template: CFML page exceptions
security: security exceptions
object: object exceptions
missingInclude: missing include file exceptions
expression: expression exceptions
lock: lock exceptions
custom_type: developer-defined exceptions, defined in the
cfthrow tag
any: all exception types
]]></help>
<values default="any">
<value option="any"/>
<value option="application"/>
<value option="database"/>
<value option="template"/>
<value option="security"/>
<value option="object"/>
<value option="missinginclude"/>
<value option="expression"/>
<value option="lock"/>
<value option="custom_type"/>
</values>
</parameter>
<possiblecombinations>
<combination attributename="template">
<required>template,type</required>
<optional>exception,mailto</optional>
</combination>
<combination attributename="type">
<required>template,type</required>
<optional>exception,mailto</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfexecute
name = " ApplicationName "
arguments = "CommandLine Arguments"
outputFile = "Output file name"
variable = "variable name"
timeout = "Timeout interval"
...
/cfexecute
-->
<tag endtagrequired="true" name="cfexecute" single="false"
xmlstyle="true">
<help><![CDATA[
Executes a CFML developer-specified process on a server
computer.
]]></help>
<return parameter="variable" type="variablename"/>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Absolute path of the application to execute.
On Windows, you must specify an extension; for example,
C:\myapp.exe.
]]></help>
<values/>
</parameter>
<parameter name="arguments" required="false" type="Object">
<help><![CDATA[
Command-line variables passed to application. If specified
as string, it is processed as follows:
* Windows: passed to process control subsystem for parsing.
* UNIX: tokenized into an array of arguments. The default
token separator is a space; you can delimit arguments
that have embedded spaces with double quotation marks.
If passed as array, it is processed as follows:
* Windows: elements are concatenated into a string of
tokens, separated by spaces. Passed to process control
subsystem for parsing.
* UNIX: elements are copied into an array of exec()
arguments
]]></help>
<values/>
</parameter>
<parameter name="outputfile" required="false" type="String">
<help><![CDATA[
File to which to direct program output. If no outputfile or
variable attribute is specified, output is displayed on
the page from which it was called.
If not an absolute path (starting a with a drive letter and
a colon, or a forward or backward slash), it is relative
to the CFML temporary directory, which is returned
by the GetTempDirectory function.
]]></help>
<values/>
</parameter>
<parameter name="variable" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
Variable in which to put program output. If no outputfile
or variable attribute is specified, output is displayed on
page from which it was called.
]]></help>
<values/>
</parameter>
<parameter name="timeout" required="false" type="Numeric">
<help><![CDATA[
Length of time, in seconds, that CFML waits for
output from the spawned program.
]]></help>
<values default="0"/>
</parameter>
<parameter name="errorVariable" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
The name of a variable in which to save the error stream output.
]]></help>
<values/>
</parameter>
<parameter name="errorFile" required="false" type="String">
<help><![CDATA[
The pathname of a file in which to save the error stream output. If not an
absolute path (starting a with a drive letter and a colon, or a forward or backward slash), it is
relative to the ColdFusion temporary directory, which is returned by the GetTempDirectory
function.
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>arguments,errorfile,outputfile,timeout</optional>
</combination>
<combination attributename="name">
<required>name</required>
<optional>arguments,errorfile,timeout,variable</optional>
</combination>
<combination attributename="name">
<required>name</required>
<optional>arguments,errorvariable,outputfile,timeout</optional>
</combination>
<combination attributename="name">
<required>name</required>
<optional>arguments,errorvariable,timeout,variable</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfexit
method = "method"
-->
<tag endtagrequired="false" name="cfexit" single="true"
xmlstyle="false">
<help><![CDATA[
This tag aborts processing of the currently executing CFML
custom tag, exits the page within the currently executing CFML
custom tag, or re-executes a section of code within the
currently executing CFML custom tag.
]]></help>
<parameter isswitchattribute="true" name="method"
required="false" type="String">
<help><![CDATA[
exittag: aborts processing of currently executing tag
exittemplate: exits page of currently executing tag
loop: reexecutes body of currently executing tag
]]></help>
<values>
<value option="exittag"/>
<value option="exittemplate"/>
<value option="loop"/>
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="exittemplate">
<required/>
<optional/>
</combination>
<combination switchvalue="exittag">
<optional>method</optional>
</combination>
<combination switchvalue="loop">
<required/>
<optional/>
</combination>
</possiblecombinations>
</tag>
<!--
cffile
action = "upload"
fileField = "formfield"
destination = "full_path_name"
nameConflict = "behavior"
accept = "mime_type/file_type"
mode = "permission"
attributes = "file_attribute_or_list">
source = "full_path_name"
charset = "charset_option">
file = "full_path_name">
variable = "var_name">
output = "content"
result = "result name"
addNewLine = "boolean"
fixnewline = "boolean"
-->
<tag endtagrequired="false" name="cffile" single="true"
xmlstyle="false">
<help><![CDATA[
Manages interactions with server files.
Different combonations cause different attributes to be
required.
]]></help>
<return parameter="result" type="variablename"/>
<return parameter="variable" type="variablename"/>
<parameter isswitchattribute="true" name="action"
required="true" type="String">
<help><![CDATA[
Type of file manipulation that the tag performs.
]]></help>
<values>
<value option="append"/>
<value option="copy"/>
<value option="delete"/>
<value option="move"/>
<value option="read"/>
<value option="readbinary"/>
<value option="rename"/>
<value option="upload"/>
<value option="uploadall"/>
<value option="write"/>
</values>
</parameter>
<parameter name="file" required="false" type="String">
<help><![CDATA[
Pathname of the file.
]]></help>
<values/>
<triggers>
<!-- keep all of them, check which ones are NOT required
status="required|optional|error"/>
-->
<selectedValue attributeName="action"
required="true" status="required" value="append"/>
<selectedValue attributeName="action"
required="true" status="required" value="delete"/>
<selectedValue attributeName="action"
required="true" status="required" value="read"/>
<selectedValue attributeName="action"
required="true" status="required" value="readBinary"/>
<selectedValue attributeName="action"
required="true" status="required" value="write"/>
</triggers>
</parameter>
<parameter name="mode" required="false" type="String">
<help><![CDATA[
Applies only to UNIX and Linux. Permissions. Octal values
of Unix chmod command. Assigned to owner, group, and
other, respectively.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" status="optional" value="append"/>
<selectedValue attributeName="action"
required="false" status="optional" value="copy"/>
<selectedValue attributeName="action"
required="false" status="optional" value="move"/>
<selectedValue attributeName="action"
required="false" status="optional" value="upload"/>
<selectedValue attributeName="action"
required="false" status="optional" value="write"/>
</triggers>
</parameter>
<parameter name="output" required="false" type="String">
<help><![CDATA[
String to add to the file
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" status="required" value="append"/>
<selectedValue attributeName="action"
required="true" status="required" value="write"/>
</triggers>
</parameter>
<parameter name="addnewline" required="false" type="boolean">
<help><![CDATA[
Yes: appends newline character to text written to file
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" status="optional" value="append"/>
<selectedValue attributeName="action"
required="false" status="optional" value="write"/>
</triggers>
</parameter>
<parameter name="attributes" required="false" type="String">
<help><![CDATA[
Applies to Windows. A comma-delimited list of attributes
to set on the file.
If omitted, the file's attributes are maintained.
]]></help>
<values>
<value option="readonly"/>
<value option="hidden"/>
<value option="normal"/>
<value deprecated="true" option="system"/>
<value deprecated="true" option="temporary"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" status="optional" value="append"/>
<selectedValue attributeName="action"
required="false" status="optional" value="move"/>
<selectedValue attributeName="action"
required="false" status="optional" value="rename"/>
<selectedValue attributeName="action"
required="false" status="optional" value="upload"/>
<selectedValue attributeName="action"
required="false" status="optional" value="write"/>
</triggers>
</parameter>
<parameter name="charset" required="false" type="String">
<help><![CDATA[
The character encoding in which the file contents is
encoded.
For more information on character encodings, see:
www.w3.org/International/O-charset.html.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" status="optional" value="append"/>
<selectedValue attributeName="action"
required="false" status="optional" value="read"/>
<selectedValue attributeName="action"
required="false" status="optional" value="write"/>
</triggers>
</parameter>
<parameter name="source" required="false" type="String">
<help><![CDATA[
Pathname of the file (durring copy).
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" status="required" value="copy"/>
<selectedValue attributeName="action"
required="true" status="required" value="move"/>
<selectedValue attributeName="action"
required="true" status="required" value="rename"/>
</triggers>
</parameter>
<parameter name="destination" required="false" type="String">
<help><![CDATA[
Pathname of a directory or file on web server
(durring copy).
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" status="required" value="copy"/>
<selectedValue attributeName="action"
required="true" status="required" value="move"/>
<selectedValue attributeName="action"
required="true" status="required" value="rename"/>
<selectedValue attributeName="action"
required="true" status="required" value="upload"/>
</triggers>
</parameter>
<parameter name="variable" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
Name of variable to contain contents of text file.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" status="required" value="read"/>
<selectedValue attributeName="action"
required="true" status="required" value="readBinary"/>
</triggers>
</parameter>
<parameter name="filefield" required="false" type="String">
<help><![CDATA[
Name of form field used to select the file.
Do not use pound signs (#) to specify the field name.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" status="required" value="upload"/>
</triggers>
</parameter>
<parameter name="nameconflict" required="false" type="String">
<help><![CDATA[
Action to take if filename is the same as that of a file
in the directory.
]]></help>
<values>
<value option="error"/>
<value option="skip"/>
<value option="overwrite"/>
<value option="makeunique"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" status="optional" value="upload"/>
</triggers>
</parameter>
<parameter name="accept" required="false" type="String">
<help><![CDATA[
Limits the MIME types to accept. Comma-delimited list. For
example, to permit JPG and Microsoft Word file uploads:
accept = "image/jpg, application/msword"
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" status="optional" value="upload"/>
</triggers>
</parameter>
<parameter name="result" required="false" type="variableName">
<help><![CDATA[
Allows you to specify a name for the variable in which cffile
returns the result (or status) parameters. If you do not specify
a value for this attribute, cffile uses the prefix "cffile".
]]></help>
<values default="cffile"/>
<triggers>
<selectedValue attributeName="action"
required="false" status="optional" value="upload"/>
</triggers>
</parameter>
<parameter name="fixnewline" required="false" type="String">
<help><![CDATA[
* Yes: changes embedded line-ending characters in string
variables to operating-system specific line endings
* No: (default) do not change embedded line-ending
characters in string variables.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" status="optional" value="append"/>
<selectedValue attributeName="action"
required="false" status="optional" value="write"/>
</triggers>
</parameter>
<possiblecombinations>
<combination switchvalue="rename">
<required>destination,source</required>
<optional>attributes,mode</optional>
</combination>
<combination switchvalue="append">
<required>file,output</required>
<optional>addnewline,attributes,fixnewline,mode,charset</optional>
</combination>
<combination switchvalue="write">
<required>file,output</required>
<optional>addnewline,attributes,charset,fixnewline,mode</optional>
</combination>
<combination switchvalue="readbinary">
<required>file,variable</required>
<optional>attributes</optional>
</combination>
<combination switchvalue="copy">
<required>destination,source</required>
<optional>attributes,mode</optional>
</combination>
<combination switchvalue="upload">
<required>destination</required>
<optional>accept,attributes,mode,nameconflict,result,filefield</optional>
</combination>
<combination switchvalue="uploadall">
<required>destination</required>
<optional>accept,attributes,mode,nameconflict,result</optional>
</combination>
<combination switchvalue="delete">
<required>file</required>
<optional>attributes,mode</optional>
</combination>
<combination switchvalue="move">
<required>destination,source</required>
<optional>attributes,charset,mode</optional>
</combination>
<combination switchvalue="read">
<required>file,variable</required>
<optional>attributes,charset,mode</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfflush
interval = "integer number of bytes"
-->
<tag endtagrequired="false" name="cfflush" single="true"
xmlstyle="false">
<help><![CDATA[
Flushes currently available data to the client.
]]></help>
<parameter name="interval" required="false" type="Numeric">
<help><![CDATA[
Flushes output each time this number of bytes becomes
available. HTML headers, and data that is already
available when the tag is executed, are omitted from the
count.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfform
name = "name"
action = "form_action"
method = "POST" or "GET"
format = "HTML" or "Flash" or "XML"
skin = "Flash or XSL skin"
style = "style specification"
preserveData = "boolean"
onSubmit = "javascript"
onReset = "javascript"
scriptSrc = "path"
codeBase = "URL"
archive = "URL"
The following attributes are supported in Flash and XML only
width = "pixels or percent"
height = "pixels or percent"
The following attributes are supported in Flash only
onError = "ActionScript code"
wMode = "window", "transparent", or "opaque"
accessible = "boolean"
preloader = "boolean"
timeout = "seconds"
The following attributes are supported in HTML and XML only
class = "form class"
enctype = "Internet media type"
id = "HTML id"
class = "css class"
style = "css style"
onload = "load event script"
onreset = "reset event script"
target = "target window or frame"
...
/cfform
-->
<tag endtagrequired="true" name="cfform" single="false"
xmlstyle="true">
<help><![CDATA[
Builds a form with CFML custom control tags; these provide
more functionality than standard HTML form input elements.
]]></help>
<parameter name="name" required="false" type="String">
<help><![CDATA[
In HTML format, if you omit this attribute and specify
an id attribute, ColdFusion does not include a name
attribute in the HTML sent to the browser; this
behavior lets you use the cfform tag to create
XHTML-compliant forms. If you omit the name
attribute and the id attribute, ColdFusion generates
a name of the form CFForm_n where n is a number
that assigned serially to the forms on a page.
]]></help>
<values/>
</parameter>
<parameter name="action" required="false" type="String">
<help><![CDATA[
Name of CFML page to execute when the form is
submitted for processing.
]]></help>
<values/>
</parameter>
<parameter name="method" required="false" type="String">
<help><![CDATA[
The method the browser uses to send the form data
to the server:
- post: Send the data using the HTTP post method,
This method sends the data in a separate message
to the server.
- get: Send the data using the HTTP get method,
which puts the form field contents in the URL
query string.
]]></help>
<values default="post">
<value option="post"/>
<value option="get"/>
</values>
</parameter>
<parameter name="format" required="false" type="String">
<help><![CDATA[
- HTML: Generate an HTML form and send it to the
client. cfgrid and cftree child controls can be in
Flash or applet format.
- Flash: Generate a Flash form and send it to the
client. All controls are in Flash format.
- XML: Generate XForms-compliant XML and save
the results in a variable specified by the name
attribute. By default, ColdFusion also applies an
XSL skin and displays the result. For more
information, see the skin attribute
]]></help>
<values default="html">
<value option="html"/>
<value option="flash"/>
<value option="xml"/>
</values>
</parameter>
<parameter name="skin" required="false" type="String">
<help><![CDATA[
Flash: Use a Macromedia halo color to stylize the output.
XML: Specfies whether to apply an XSL skin and
display the resulting HTML to the client. Can be any
of the following:
- ColdFusion MX skin name: Apply the specified skin.
- XSL file name: Apply the skin located in the specified path.
- "none": Do not apply an XSL skin. You must use XForms XML then.
- (omitted) or "default": Use the ColdFusion MX default skin.
]]></help>
<values>
<value option="haloSilver"/>
<value option="haloBlue"/>
<value option="haloGreen"/>
<value option="haloOrange"/>
<value option="beige"/>
<value option="blue"/>
<value option="bluegray"/>
<value option="lightgray"/>
<value option="red"/>
<value option="silver"/>
<value option="none"/>
<value option="default"/>
<value option="basic"/>
<value option="basiccss"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
<selectedValue attributeName="format"
required="false" value="xml"/>
</triggers>
</parameter>
<parameter name="preservedata" required="false" type="boolean">
<help><![CDATA[
When the cfform action attribute posts back to the same
page as the form, this determines whether to override the
control values with the submitted values.
- false: values specified in the control tag attributes are used
- true: corresponding submitted values are used
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="html"/>
<selectedValue attributeName="format"
required="false" value="xml"/>
</triggers>
</parameter>
<parameter name="onload" required="false" type="String">
<help><![CDATA[
JavaScript to execute when the form loads.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="html"/>
<selectedValue attributeName="format"
required="false" value="xml"/>
</triggers>
</parameter>
<parameter name="onsubmit" required="false" type="String">
<help><![CDATA[
JavaScript or Actionscript function to execute to
preprocess data before form is submitted. If any
child tags specify onSubmit field validation, ColdFusion
does the validation before executing this JavaScript.
]]></help>
<values/>
</parameter>
<parameter name="codebase" required="false" type="String">
<help><![CDATA[
URL of downloadable JRE plug-in (for Internet Explorer only).
Default: /CFIDE/classes/cf-j2re-win.cab
]]></help>
<values default="/CFIDE/classes/cf-j2re-win.cab"/>
<triggers>
<selectedValue attributeName="format"
required="false" value="html"/>
<selectedValue attributeName="format"
required="false" value="xml"/>
</triggers>
</parameter>
<parameter name="archive" required="false" type="String">
<help><![CDATA[
URL of downloadable Java classes for CFML controls.
Default: /CFIDE/classes/cfapplets.jar
]]></help>
<values default="/CFIDE/classes/cfapplets.jar"/>
<triggers>
<selectedValue attributeName="format"
required="false" value="html"/>
<selectedValue attributeName="format"
required="false" value="xml"/>
</triggers>
</parameter>
<parameter name="height" required="false" type="String">
<help><![CDATA[
The height of the form. Use a number to specify
pixels, In Flash, you can use a percentage value to
specify a percentage of the available width. The
displayed height might be less than the specified size.
]]></help>
<values default="100%"/>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
<selectedValue attributeName="format"
required="false" value="xml"/>
</triggers>
</parameter>
<parameter name="width" required="false" type="String">
<help><![CDATA[
The width of the form. Use a number to specify
pixels, In Flash, you can use a percentage value to
specify a percentage of the available width.
]]></help>
<values default="100%"/>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
<selectedValue attributeName="format"
required="false" value="xml"/>
</triggers>
</parameter>
<parameter name="onerror" required="false" type="String">
<help><![CDATA[
Applies only for onSubmit or onBlur validation; has
no effect for onServer validation. An ActionScript
expression or expressions to execute if the user
submits a form with one or more validation errors.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="wmode" required="false" type="String">
<help><![CDATA[
Specifies how the Flash form appears relative to
other displayable content that occupies the same
space on an HTML page.
- window: The Flash form is the topmost layer on the
page and obscures anything that would share the
space, such as drop-down dynamic HTML lists.
- transparent: The Flash form honors the z-index of
dhtml so you can float items above it. If the Flash
form is above any item, transparent regions in the
form show the content that is below it.
- opaque: The Flash form honors the z-index of
dhtml so you can float items above it. If the Flash
form is above any item, it blocks any content that is
below it.
Default is: window.
]]></help>
<values default="window">
<value option="window"/>
<value option="transparent"/>
<value option="opaque"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="accessible" required="false" type="boolean">
<help><![CDATA[
Specifies whether to include support screen readers
in the Flash form. Screen reader support adds
approximately 80KB to the SWF file sent to the
client. Default is: false.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="preloader" required="false" type="boolean">
<help><![CDATA[
Specifies whether to display a progress bar when
loading the Flash form. Default is: true.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="timeout" required="false" type="Numeric">
<help><![CDATA[
Integer number of seconds for which to keep the
form data in the Flash cache on the server. A value of
0 prevents the data from being cached.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="scriptsrc" required="false" type="String">
<help><![CDATA[
Specifies the URL, relative to the web root, of the
directory that contains the cfform.js file with the
client-side JavaScript used by this tag and its child
tags. For XML format forms, this directory is also the
default directory for XSLT skins.
]]></help>
<values/>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
Styles to apply to the form. In HTML or XML format,
ColdFusion passes the style attribute to the browser
or XML. In Flash format, must be a style specification
in CSS format.
]]></help>
<values/>
</parameter>
<parameter name="onreset" required="false" type="String">
<help><![CDATA[
JavaScript to execute when the user clicks a reset button.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="html"/>
<selectedValue attributeName="format"
required="false" value="xml"/>
</triggers>
</parameter>
<parameter name="id" required="false" type="String">
<help><![CDATA[
HTML id passed through to <FORM>.
]]></help>
<values/>
</parameter>
<parameter name="target" required="false" type="String">
<help><![CDATA[
Target window or frame passed through to <FORM>.
]]></help>
<values/>
</parameter>
<parameter deprecated="true" name="passthrough"
required="false" type="String">
<help><![CDATA[
This attribute is deprecated.
Passes arbitrary attribute-value pairs to the HTML code
that is generated for the tag. You can use either of the
following formats:
passthrough="title=""myTitle"""
passthrough='title="mytitle"'
]]></help>
<values/>
</parameter>
<parameter name="onsuccess" required="false" type="String">
<help><![CDATA[
Applies only to forms inside cfdiv, cflayout, cfpod, or cfwindow controls. The name of a JavaScript function that will run when an asynchronous form submission succeeds.
]]></help>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfformgroup
type = "group type"
label = "label"
id = "id"
style = "style specification"
selectedIndex = "page number">
width = "pixels"
height = "pixels"
enabled = "boolean"
visible = "boolean"
OnChange = "ActionScript expression"
toolTip = "Tip text"
...ColdFusion forms controls
/cfformgroup
or
cfformgroup
id = "id"
type = "repeater"
query = "query object"
startrow = "row number"
maxrows = "integer">
...ColdFusion forms controls
/cfformgroup
-->
<tag endtagrequired="true" name="cfformgroup" single="false"
xmlstyle="true">
<help><![CDATA[
Creates a container control for multiple form controls.
Used in the cfform tag body of Macromedia Flash and XML
forms. Ignored in HTML forms.
]]></help>
<parameter name="type" required="true" type="String">
<help><![CDATA[
For XML forms can be any XForms group type defined in the XSLT.
For Flash see the value options and docs for more information.
]]></help>
<values>
<value option="horizontal"/>
<value option="vertical"/>
<value option="fieldset"/>
<value option="repeater"/>
<value option="horizontal"/>
<value option="vertical"/>
<value option="hbox"/>
<value option="vbox"/>
<value option="hdividedbox"/>
<value option="vdividedbox"/>
<value option="panel"/>
<value option="tile"/>
<value option="accordion"/>
<value option="tabnavigator"/>
<value option="page"/>
</values>
</parameter>
<parameter name="query" required="false" type="query">
<help><![CDATA[
The query to use with the repeater. Flash creates an
instance of each of the cfformgroup tag's child tags for
each row in the query. You can use the bind attribute in
the child tags to use data from the query row for the
instance.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="type" required="true" value="repeater"/>
</triggers>
</parameter>
<parameter name="startrow" required="false" type="Numeric">
<help><![CDATA[
Used only for the repeater type; ignored otherwise.
Specifies the row number of the first row of the query to
use in the Flash form repeater. This attribute is zerobased:
the first row is row 0, not row 1 (as in most ColdFusion tags).
Default: 0
]]></help>
<values default="0"/>
<triggers>
<selectedValue attributeName="type" required="false" value="repeater"/>
</triggers>
</parameter>
<parameter name="maxrows" required="false" type="Numeric">
<help><![CDATA[
Used only for for the repeater type; ignored otherwise.
Specifies the maximum number of query rows to use in
the Flash form repeater. If the query has more rows than
the sum of the startrow attribute and this value, the
repeater does not use the remaining rows.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="type" required="false" value="repeater"/>
</triggers>
</parameter>
<parameter name="label" required="false" type="String">
<help><![CDATA[
Label to apply to the form group. In Flash, does the following:
- For a page or panel form group, determines the label to
put on the corresponding accordion pleat, the tabnavigator tab,
or the panel title bar. For a Flash horizontal or vertical form
group, specifies the label to put to the left of the group.
- Ignored in Flash for repeater, hbox, hdividedbox, vbox,
vdividedbox, tile, accordion, and tabnavigator types.
]]></help>
<values/>
</parameter>
<parameter name="id" required="false" type="String">
<help><![CDATA[
ID for form input element.
]]></help>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
Flash: A Flash style specification in CSS format.
XML: An inline CSS style specification.
]]></help>
<values/>
</parameter>
<parameter name="selectedindex" required="false" type="Numeric">
<help><![CDATA[
Used only for accordion and tabnavigator types; ignored
otherwise. Specifies the page control to display as open,
where 0 (not 1) specifies the first page control defined in
the group.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="type" required="false" value="accordion"/>
<selectedValue attributeName="type" required="false" value="tabnavigator"/>
</triggers>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Width of the group container, in pixels. If you omit this
attribute, Flash automatically sizes the container width.
Ignored for Flash repeater type.
]]></help>
<values/>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
Height of the group container, in pixels. If you omit this
attribute, Flash automatically sizes the container height.
Ignored for Flash repeater type.
]]></help>
<values/>
</parameter>
<parameter name="enabled" required="false" type="boolean">
<help><![CDATA[
Flash only: Boolean value specifying whether the controls in the
form group are enabled. Disabled controls appear in
light gray.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="visible" required="false" type="boolean">
<help><![CDATA[
Flash only: Boolean value specifying whether the controls in the
form group are visible. If the controls are invisible, the
space that would be occupied by visible controls is blank.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="onchange" required="false" type="String">
<help><![CDATA[
Flash only: tabnavigator and accordion types only: ActionScript
expression or expressions to execute when a new tab or
accordion page is selected. Note: The onChange event
occurs when the form first displays.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="type" required="false" value="accordion"/>
<selectedValue attributeName="type" required="false" value="tabnavigator"/>
</triggers>
</parameter>
<parameter name="tooltip" required="false" type="String">
<help><![CDATA[
Flash only: Text to display when the mouse pointer hovers in the
form group area. If a control in the form group also
specifies a tooltip, Flash displays the control's tolltip
when the mouse pointer hovers over the control.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfformitem
type = "hrule, vrule, or spacer"
style = "style specification"
width = "pixels"
height = "pixels"
visible = "boolean"
or
cfformitem
type= "html or text or script"
style = "style specification"
width = "pixels"
height = "pixels"
visible = "boolean"
enabled = "boolean"
tooltip = "Tip text"
bind = "bind expresion"
...text
/cfformitem
-->
<tag endtagrequired="true" name="cfformitem" single="false"
xmlstyle="true">
<help><![CDATA[
Inserts a horizontal line, a vertical line, a spacer,
or text in a Flash form. Used in the cfform or cfformgroup
tag body for Flash and XML forms. Ignored in HTML forms.
]]></help>
<parameter name="type" required="true" type="String">
<help><![CDATA[
Form item type. See docs for more details.
]]></help>
<values>
<value option="html"/>
<value option="text"/>
<value option="script"/>
<value option="spacer"/>
<value option="hrule"/>
<value option="vrule"/>
</values>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
Flash: Must be a style specification in CSS format.
Ignored if the type attribute is html or text.
XML: ColdFusion passes the style attribute to the XML.
ColdFusion skins include the style attribute to the
generated HTML.
]]></help>
<values/>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Width of the item, in pixels. If you omit this attribute, Flash
automatically sizes the width. In ColdFusion XSL skins,
use the style attribute, instead.
]]></help>
<values/>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
Height of the item, in pixels. If you omit this attribute,
Flash automatically sizes the width. In ColdFusion XSL
skins, use the style attribute, instead.
]]></help>
<values/>
</parameter>
<parameter name="enabled" required="false" type="boolean">
<help><![CDATA[
Boolean value specifying whether the control is enabled.
Disabled text appear in light gray. Has no effect on
spacers and rules.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="visible" required="false" type="boolean">
<help><![CDATA[
Boolean value specifying whether to show the control.
Space that would be occupied by an invisible control is
blank. Has no effect on spacers.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="tooltip" required="false" type="String">
<help><![CDATA[
Text to display when the mouse pointer hovers over the
control. Has no effect on spacers.
]]></help>
<values/>
</parameter>
<parameter name="bind" required="false" type="String">
<help><![CDATA[
A Flash bind expression that populates the field with
information from other form fields. If you use this
attribute, ColdFusion MX ignores any text that you
specify in the body of the cftextitem tag. This attribute
can be useful if the cfformitem tag is in a cfformgroup
type="repeater" tag.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<tag endtagrequired="false" name="cfftp" single="true"
xmlstyle="false">
<help><![CDATA[
Lets users implement File Transfer Protocol (FTP) operations.
]]></help>
<return type="Struct" parameter="result"/>
<return type="variablename" parameter="connection"/>
<parameter isswitchattribute="true" name="action"
required="true" type="String">
<help><![CDATA[
FTP operation to perform.
open: create an FTP connection
close: terminate an FTP connection
]]></help>
<values>
<value option="open"/>
<value option="close"/>
<value option="changedir"/>
<value option="createdir"/>
<value option="listdir"/>
<value option="removedir"/>
<value option="getfile"/>
<value option="putfile"/>
<value option="rename"/>
<value option="remove"/>
<value option="getcurrentdir"/>
<value option="getcurrenturl"/>
<value option="existsdir"/>
<value option="existsfile"/>
<value option="exists"/>
<value option="quote"/>
<value option="site"/>
<value option="allo"/>
<value option="acct"/>
</values>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
Overrides username specified in ODBC setup.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="connection"
required="true" value=""/>
<selectedValue attributeName="action"
required="true" value="open"/>
</triggers>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Overrides password specified in ODBC setup.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="connection"
required="true" value=""/>
<selectedValue attributeName="action"
required="true" value="open"/>
</triggers>
</parameter>
<parameter name="server" required="false" type="String">
<help><![CDATA[
FTP server to which to connect; for example,
ftp.myserver.com
]]></help>
<values/>
<triggers>
<selectedValue attributeName="connection"
required="true" value=""/>
<selectedValue attributeName="action"
required="true" value="open"/>
</triggers>
</parameter>
<parameter name="timeout" required="false" type="Numeric">
<help><![CDATA[
Value in seconds for the timeout of all operations,
including individual data request operations.
]]></help>
<values default="30"/>
</parameter>
<parameter name="port" required="false" type="Numeric">
<help><![CDATA[
Remote port to which to connect
]]></help>
<values default="21"/>
</parameter>
<parameter name="connection" required="false" type="variableName">
<help><![CDATA[
Name of the FTP connection. If you specify the username,
password, and server attributes, and if no connection
exists for them, CFML creates one. Calls to cfftp
with the same connection name reuse the connection.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="open"/>
<selectedValue attributeName="action"
required="true" value="close"/>
</triggers>
</parameter>
<parameter name="proxyserver" required="false" type="String">
<help><![CDATA[
The proxy server required to access the URL.
]]></help>
<values/>
</parameter>
<parameter name="retrycount" required="false" type="Numeric">
<help><![CDATA[
Number of retries until failure is reported.
]]></help>
<values default="1"/>
</parameter>
<parameter name="stoponerror" required="false" type="boolean">
<help><![CDATA[
Yes: halts processing, displays an appropriate error.
No: populates the error variables
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="passive" required="false" type="boolean">
<help><![CDATA[
Yes: enable passive mode
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="transfermode" required="false" type="String">
<help><![CDATA[
ASCII FTP transfer mode
Binary FTP transfer mode
Auto FTP transfer mode
]]></help>
<values default="auto">
<value option="auto"/>
<value option="ascii"/>
<value option="binary"/>
</values>
</parameter>
<parameter name="failifexists" required="false" type="boolean">
<help><![CDATA[
Yes: if a local file with same name exists, getFile fails
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="directory" required="false" type="String">
<help><![CDATA[
Directory on which to perform an operation
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="changedir"/>
<selectedValue attributeName="action"
required="true" value="createdir"/>
<selectedValue attributeName="action"
required="true" value="listdir"/>
<selectedValue attributeName="action"
required="true" value="existsdir"/>
</triggers>
</parameter>
<parameter name="localfile" required="false" type="String">
<help><![CDATA[
Name of the file on the local file system
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="getfile"/>
<selectedValue attributeName="action"
required="true" value="putfile"/>
</triggers>
</parameter>
<parameter name="remotefile" required="false" type="String">
<help><![CDATA[
Name of the file on the FTP server file system.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="getfile"/>
<selectedValue attributeName="action"
required="true" value="putfile"/>
<selectedValue attributeName="action"
required="true" value="existsfile"/>
</triggers>
</parameter>
<parameter name="item" required="false" type="String">
<help><![CDATA[
Object of these actions: file or directory.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="remove"/>
<selectedValue attributeName="action"
required="true" value="exists"/>
</triggers>
</parameter>
<parameter name="existing" required="false" type="String">
<help><![CDATA[
Current name of the file or directory on the remote server.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="rename"/>
</triggers>
</parameter>
<parameter name="new" required="false" type="String">
<help><![CDATA[
New name of file or directory on the remote server
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="rename"/>
</triggers>
</parameter>
<parameter name="name" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
Query name of directory listing.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="listdir"/>
</triggers>
</parameter>
<parameter name="result" required="false" returnVarType="Struct" type="String">
<help><![CDATA[
Specifies a name for the structure in which cfftp
stores the returnValue variable. If set, this value
replaces cfftp as the prefix to use when accessing
returnVariable.
]]></help>
<values/>
</parameter>
<parameter name="attributes" required="false" type="String">
<help><![CDATA[
Attributes of the current element: normal or Directory.
]]></help>
</parameter>
<parameter name="passphrase" required="false" type="String">
<help><![CDATA[
Used when key is specified. Because private keys are stored in an encrypted form on the client host, the user must supply a passphrase to enable generating the signature.
]]></help>
</parameter>
<parameter name="buffersize" required="false" type="Numeric">
<help><![CDATA[
Buffer size in bytes.
]]></help>
</parameter>
<parameter name="secure" required="false" type="String">
<help><![CDATA[
* yes: enables secure FTP
* no
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="asciiextensionlist" required="false" type="String">
<help><![CDATA[
Delimited list of file extensions that force ASCII
transfer mode, if transferMode = "auto".
]]></help>
</parameter>
<parameter name="key" required="false" type="String">
<help><![CDATA[
Public-key-based authentication. Refers to the absolute path to the private key of the user.
Possession of a private key provides authentication by sending a signature created with a private key.
The server must ensure that the key is a valid authentication for the user and that the signature is valid.
Both must be valid to accept the authentication.
]]></help>
</parameter>
<parameter name="actionparam" required="false" type="String">
<help><![CDATA[
Used only when action is quote, site, or acct. Specifies the command when action is quote or site; specifies account information when action is acct.
]]></help>
</parameter>
<parameter name="fingerprint" required="false" type="String">
<help><![CDATA[
Fingerprint of the host key in the form ssh-dss.ssh-rsa, which is a 16-byte unique identifier for the server attribute that you specify.
]]></help>
</parameter>
<possiblecombinations>
<combination switchvalue="createdir">
<required>directory</required>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="close">
<required>connection</required>
<optional>result,retrycount,stoponerror,timeout</optional>
</combination>
<combination switchvalue="existsfile">
<required>remotefile</required>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="acct">
<required>actionparam</required>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="putfile">
<required>localfile</required>
<optional>asciiextensionlist,buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,remotefile,result,retrycount,server,stoponerror,timeout,transfermode,username</optional>
</combination>
<combination switchvalue="exists">
<required>item</required>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="getcurrenturl">
<required/>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="changedir">
<required>directory</required>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="getcurrentdir">
<required/>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="remove">
<required>item</required>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="allo">
<required/>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="existsdir">
<required>directory</required>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="listdir">
<required>directory,name</required>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="quote">
<required>actionparam</required>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="rename">
<required>existing,new</required>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="open">
<required>server,username</required>
<optional>asciiextensionlist,buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,secure,stoponerror,timeout,transfermode</optional>
</combination>
<combination switchvalue="site">
<required>actionparam</required>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="removedir">
<required>directory</required>
<optional>buffersize,connection,fingerprint,key,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="getfile">
<required>remotefile</required>
<optional>asciiextensionlist,attributes,buffersize,connection,failifexists,fingerprint,key,localfile,passive,passphrase,password,port,proxyserver,result,retrycount,server,stoponerror,timeout,transfermode,username</optional>
</combination>
</possiblecombinations>
</tag>
<tag allowanyattribute="true" canHaveAttributeCollection="false" endtagrequired="true"
name="cffunction" single="false"
xmlstyle="false">
<help><![CDATA[
Defines a function that you can call in CFML. Required to
defined CFML component methods.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
A string; a component method that is used within the
cfcomponent tag.
]]></help>
<values/>
</parameter>
<parameter name="returntype" required="false" type="String">
<help><![CDATA[
String; a type name; data type of the function return value
Required for a web service; Optional, otherwise.
]]></help>
<values default="Any">
<value option="Any"/>
<value option="Array"/>
<value option="Binary"/>
<value option="boolean"/>
<value option="date"/>
<value option="guid"/>
<value option="Numeric"/>
<value option="Query"/>
<value option="String"/>
<value option="Struct"/>
<value option="UUID"/>
<value option="variablename"/>
<value option="void"/>
<value option="xml"/>
<value option="(component name)"/>
</values>
</parameter>
<parameter name="roles" required="false" type="String">
<help><![CDATA[
A comma-delimited list of CFML security roles that
can invoke the method. Only users who are logged in with
the specified roles can execute the function. If this
attribute is omitted, all users can invoke the method
]]></help>
<values default=""/>
</parameter>
<parameter name="access" required="false" type="String">
<help><![CDATA[
The client security context from which the method can be
invoked:
private: available only to the component that declares the
method and any components that extend the component in
which it is defined
package: available only to the component that declares the
method, components that extend the component, or any
other components in the package
public: available to a locally executing page or component
method
remote: available to a locally or remotely executing page
or component method, or a remote client through a URL,
Flash, or a web service. To publish the function as a
web service, this option is required.
]]></help>
<values default="public">
<value option="private"/>
<value option="package"/>
<value option="public"/>
<value option="remote"/>
</values>
</parameter>
<parameter name="output" required="false" type="boolean">
<help><![CDATA[
Specifies under which conditions the function can generate
HTML output.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="displayname" required="false" type="String">
<help><![CDATA[
Meaningful only for CFC method parameters. A value to be
displayed in parentheses following the function name when
using introspection to show information about the CFC
]]></help>
<values/>
</parameter>
<parameter name="hint" required="false" type="String">
<help><![CDATA[
Meaningful only for CFC method parameters. Text to be
displayed when using introspection to show information
about the CFC. The hint attribute value follows the syntax
line in the function description
]]></help>
<values/>
</parameter>
<parameter name="description" required="false" type="String">
<help><![CDATA[
Supplies a short text description of the function.
]]></help>
<values/>
</parameter>
<parameter name="returnformat" required="false" type="String">
<help><![CDATA[
The format in which to return values to a remote caller.
]]></help>
<values>
<value option="JSON"/>
<value option="plain"/>
<value option="WDDX"/>
</values>
</parameter>
<parameter name="securejson" required="false" type="boolean">
<help><![CDATA[
A Boolean value that specifies whether to add a security prefix in front of any value that the function returns in JSON-format in response to a remote call.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="verifyclient" required="false" type="boolean">
<help><![CDATA[
A Boolean value that specifies whether to require remote function calls to include an encrypted security token. For use with ColdFusion AJAX applications only.
]]></help>
<values ddefault="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</tag>
<tag endtagrequired="true" name="cfgrid" single="false"
xmlstyle="true">
<help><![CDATA[
Used within the cfform tag. Puts a grid control (a table of
data) in a CFML form. To specify grid columns and row
data, use the cfgridcolumn and cfgridrow tags, or use the
query attribute, with or without cfgridcolumn tags.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Name of grid element.
]]></help>
<values/>
</parameter>
<parameter name="bind" required="false" type="String">
<help><![CDATA[
A bind expression specifying used to fill the
contents of the grid. Cannot be used with the
query attribute.
]]></help>
<values/>
</parameter>
<parameter name="pagesize" required="false" type="Numeric">
<help><![CDATA[
The number of rows to display per page for a
dynamic grid. If the number of available rows
exceeds the page size, the grid displays only
the specified number of entries on a single
page, and the user navigates between pages
to show all data. The grid retrieves data for
each page only when it is required for display.
This attribute is ignored if you specify a query
attribute.
]]></help>
<values/>
</parameter>
<parameter name="striperowcolor" required="false" type="String">
<help><![CDATA[
The color to use for one of the alternating
stripes. The bgColor setting determines the
other color
]]></help>
<values/>
</parameter>
<parameter name="preservepageonsort" required="false" type="boolean">
<help><![CDATA[
Specifies whether to display the page with
the current page number, or display page 1,
after sorting (or resorting) the grid
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="striperows" required="false" type="boolean">
<help><![CDATA[
Specifies whether to display the page with
the current page number, or display page 1,
after sorting (or resorting) the grid
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="format" required="false" type="String">
<help><![CDATA[
- applet: generates a Java applet.
- Flash: generates a Flash grid control.
- xml: generates an XMLrepresentation of the grid.
In XML format forms, includes the generated XML in the form.
In HTML format forms, puts the XML in a string variable
with the name specified by the name attribute.
Default: applet
]]></help>
<values default="applet">
<value option="applet"/>
<value option="flash"/>
<value option="xml"/>
<value option="html"/>
</values>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
Control's height, in pixels.
Default for applet: 300
]]></help>
<values default="300"/>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Control's width, in pixels.
Default for applet: 300
]]></help>
<value default="300"/>
</parameter>
<parameter name="autowidth" required="false" type="boolean">
<help><![CDATA[
Yes: sets column widths so that all columns display within
grid width.
No: sets columns to equal widths. User can resize columns.
Horizontal scroll bars are not available, because if
you specify a column width and set autoWidth = "Yes",
CFML sets to this width, if possible
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="vspace" required="false" type="Numeric">
<help><![CDATA[
Vertical margin above and below control, in pixels.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="hspace" required="false" type="Numeric">
<help><![CDATA[
Horizontal spacing to left and right of control, in pixels.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="align" required="false" type="String">
<help><![CDATA[
Alignment of the grid cell contents
]]></help>
<values>
<value option="top"/>
<value option="left"/>
<value option="bottom"/>
<value option="baseline"/>
<value option="texttop"/>
<value option="absbottom"/>
<value option="middle"/>
<value option="absmiddle"/>
<value option="right"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="query" required="false" type="query">
<help><![CDATA[
Name of query associated with grid control.
]]></help>
<values/>
</parameter>
<parameter name="insert" required="false" type="boolean">
<help><![CDATA[
User can insert row data in grid.
Takes effect only if selectmode="edit"
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="selectmode"
required="false" value="edit"/>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="delete" required="false" type="boolean">
<help><![CDATA[
User can delete row data from grid.
Takes effect only if selectmode="edit"
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="selectmode"
required="false" value="edit"/>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="sort" required="false" type="boolean">
<help><![CDATA[
The sort button performs simple text sort on column. User
can sort columns by clicking column head or by clicking
sort buttons. Not valid with selectmode=browse.
Yes: sort buttons display on grid control
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="selectMode"
required="false" value="edit"/>
<selectedValue attributeName="selectMode"
required="false" value="single"/>
<selectedValue attributeName="selectMode"
required="false" value="row"/>
<selectedValue attributeName="selectMode"
required="false" value="column"/>
</triggers>
</parameter>
<parameter name="font" required="false" type="String">
<help><![CDATA[
Font of data in column.
]]></help>
<values default="arial">
<value option="arial"/>
<value option="times"/>
<value option="courier"/>
<value option="arialunicodeMS"/>
</values>
</parameter>
<parameter name="fontsize" required="false" type="Numeric">
<help><![CDATA[
Size of text in column.
]]></help>
<values/>
</parameter>
<parameter name="italic" required="false" type="boolean">
<help><![CDATA[
Yes: displays grid control text in italics
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="bold" required="false" type="boolean">
<help><![CDATA[
Yes: displays grid control text in bold
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="textcolor" required="false" type="String">
<help><![CDATA[
Text color for control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values default="black">
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="href" required="false" type="String">
<help><![CDATA[
URL or query column name that contains a URL to hyperlink
each grid column with.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="hrefkey" required="false" type="String">
<help><![CDATA[
The query column to use for the value appended to the href
URL of each column, instead of the column's value.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="target" required="false" type="String">
<help><![CDATA[
Frame in which to open link specified in href.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="appendkey" required="false" type="boolean">
<help><![CDATA[
When used with href, passes CFTREEITEMKEY variable
with the value of the selected tree item in URL to the
application page specified in the cfform action
attribute
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="highlighthref" required="false" type="boolean">
<help><![CDATA[
Yes: Highlights links that are associated with a cftreeitem
with a URL attribute value.
No: Disables highlight.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="onvalidate" required="false" type="String">
<help><![CDATA[
JavaScript function to validate user input. The form object,
input object, and input object value are passed to the
specified routine, which should return True if validation
succeeds; False, otherwise.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="onerror" required="false" type="String">
<help><![CDATA[
JavaScript function to execute if validation fails.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="griddataalign" required="false" type="String">
<help><![CDATA[
Left: left-aligns data within column.
Right: right-aligns data within column.
Center: center-aligns data within column.
]]></help>
<values default="left">
<value option="left"/>
<value option="center"/>
<value option="right"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="gridlines" required="false" type="boolean">
<help><![CDATA[
Yes: enables row and column rules in grid control
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="rowheight" required="false" type="Numeric">
<help><![CDATA[
Minimum row height, in pixels, of grid control. Used with
cfgridcolumn type = "Image"; defines space for graphics to
display in row.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="rowheaders" required="false" type="boolean">
<help><![CDATA[
Yes: displays a column of numeric row labels in grid
control
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="rowheaderalign" required="false" type="String">
<help><![CDATA[
Left: left-aligns data within row header
Right: right-aligns data within row header
Center: center-aligns data within row header
]]></help>
<values default="left">
<value option="left"/>
<value option="center"/>
<value option="right"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="rowheaderfont" required="false" type="String">
<help><![CDATA[
Font of data in column.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="rowheaderfontsize" required="false" type="Numeric">
<help><![CDATA[
Size of text in column.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="rowheaderitalic" required="false" type="boolean">
<help><![CDATA[
Yes: displays grid control text in italics
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="rowheaderbold" required="false" type="boolean">
<help><![CDATA[
Yes: displays grid control text in bold
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="rowheadertextcolor" required="false" type="String">
<help><![CDATA[
Text color for control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values default="black">
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="colheaders" required="false" type="boolean">
<help><![CDATA[
Yes: displays a column of numeric row labels in grid
control
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="colheaderalign" required="false" type="String">
<help><![CDATA[
Left: left-aligns data within row header
Right: right-aligns data within row header
Center: center-aligns data within row header
]]></help>
<values default="left">
<value option="left"/>
<value option="center"/>
<value option="right"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="colheaderfont" required="false" type="String">
<help><![CDATA[
Font of data in column.
]]></help>
<values/>
</parameter>
<parameter name="colheaderfontsize" required="false" type="Numeric">
<help><![CDATA[
Size of text in column.
]]></help>
<values/>
</parameter>
<parameter name="colheaderitalic" required="false" type="boolean">
<help><![CDATA[
Yes: displays grid control text in italics
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="colheaderbold" required="false" type="boolean">
<help><![CDATA[
Yes: displays grid control text in bold
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="colheadertextcolor" required="false" type="String">
<help><![CDATA[
Text color for control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values>
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="bgcolor" required="false" type="String">
<help><![CDATA[
Background color of grid control.
]]></help>
<values>
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="selectcolor" required="false" type="String">
<help><![CDATA[
Background color for a selected item.
]]></help>
<values>
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="selectmode" required="false" type="String">
<help><![CDATA[
Selection mode for items in the control.
- Edit: user can edit grid data. Selecting a cell opens
the editor for the cell type.
- Row: user selections automatically extend to the row
that contains selected cell.
- Single: user selections are limited to selected cell.
(Applet only)
- Column: user selections automatically extend
to column that contains selected cell. (Applet only)
- Browse: user can only browse grid data. (Applet only)
]]></help>
<values>
<value option="edit"/>
<value option="single"/>
<value option="row"/>
<value option="column"/>
<value option="browse"/>
</values>
</parameter>
<parameter name="maxrows" required="false" type="Numeric">
<help><![CDATA[
Maximum number of rows to display in grid.
]]></help>
<values/>
</parameter>
<parameter name="notsupported" required="false" type="String">
<help><![CDATA[
Text to display if a page that contains a Java applet-based
cfform control is opened by a browser that does not
support Java or has Java support disabled.
Default:
"<b>Browser must support Java to <br>view ColdFusion Java
Applets!</b>"
]]></help>
<values default="<b>Browser must support Java to <br>view ColdFusion Java Applets!</b>"/>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="picturebar" required="false" type="boolean">
<help><![CDATA[
Yes: images for Insert, Delete, Sort buttons
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="insertbutton" required="false" type="String">
<help><![CDATA[
Text for the insert button. Takes effect only if
selectmode="edit".
]]></help>
<values/>
<triggers>
<selectedValue attributeName="selectmode"
required="false" value="edit"/>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="deletebutton" required="false" type="String">
<help><![CDATA[
Text of Delete button text. Takes effect only if
selectmode="edit".
]]></help>
<values/>
<triggers>
<selectedValue attributeName="selectmode"
required="false" value="edit"/>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="sortascendingbutton" required="false" type="String">
<help><![CDATA[
Sort button text
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="sortdescendingbutton" required="false" type="String">
<help><![CDATA[
Sort button text
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="xml"/>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
Flash only: Must be a style specification in CSS format.
Ignored for type="text".
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="enabled" required="false" type="boolean">
<help><![CDATA[
Flash only: Boolean value specifying
whether the control is enabled. A disabled
control appears in light gray.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="visible" required="false" type="boolean">
<help><![CDATA[
Flash only: Boolean value specifying
whether to show the control. Space that would
be occupied by an invisible control is blank.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="tooltip" required="false" type="String">
<help><![CDATA[
Flash only: text to display when the
mouse pointer hovers over the control.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="onchange" required="false" type="String">
<help><![CDATA[
Flash only: ActionScript to run when the control changes
due to user action in the control.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="bindonload" required="false" type="Boolean">
<help><![CDATA[
* yes: executes the bind attribute expression when first loading the form.
* no: does not execute the bind attribute expression until the first bound event.
Ignored if there is no bind attribute.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="selectonload" required="false" type="Boolean">
<help><![CDATA[
* yes: selects the first row of the grid when the gird loads.
* no: does not select any rows when the grid loads.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="onblur" required="false" type="String">
<help><![CDATA[
ActionScript that runs when the grid loses focus.
]]></help>
<values/>
</parameter>
<parameter name="onfocus" required="false" type="String">
<help><![CDATA[
ActionScript that runs when the grid gets focus.
]]></help>
<values/>
</parameter>
<parameter name="collapsible" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether the user can collapse the entire grid by clicking an arrow on the title bar.
]]></help>
<value>
<values option="true" />
<values option="false" />
</value>
</parameter>
<parameter name="groupfield" required="false" type="String">
<help><![CDATA[
Puts the grid rows into groups, organized by the column specified in this attribute. Each group is collapsible and has a header with the column name, group field value, and number of entries in the group.
]]></help>
</parameter>
<parameter name="onLoad" required="false" type="String">
<help><![CDATA[
Java Script funtion that gets called when a grid is loaded for first time
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>align,appendkey,autowidth,bgcolor,bind,bindonload,bold,colheaderalign,colheaderbold,colheaderfont,colheaderfontsize,colheaderitalic,colheaders,colheadertextcolor,delete,deletebutton,enabled,font,fontsize,format,griddataalign,gridlines,height,highlighthref,href,hrefkey,hspace,insert,insertbutton,italic,label,maxrows,notsupported,onblur,onchange,onerror,onfocus,onvalidate,pagesize,picturebar,preservepageonsort,query,rowheaderalign,rowheaderbold,rowheaderfont,rowheaderfontsize,rowheaderitalic,rowheaders,rowheadertextcolor,rowheaderwidth,rowheight,selectcolor,selectmode,selectonload,sort,sortascendingbutton,sortdescendingbutton,striperowcolor,striperows,style,target,textcolor,tooltip,visible,vspace,width,groupfield,collapsible</optional>
</combination>
</possiblecombinations>
</tag>
<tag endtagrequired="false" name="cfgridcolumn" single="true"
xmlstyle="false">
<help><![CDATA[
Used with the cfgrid tag in a cfform. Use this tag to specify
column data in a cfgrid control. The font and alignment
attributes used in cfgridcolumn override global font or
alignment settings defined in cfgrid.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Name of grid column element. If grid uses a query, column
name must specify name of a query column.
]]></help>
<values/>
</parameter>
<parameter name="header" required="false" type="String">
<help><![CDATA[
Column header text. Used only if cfgrid colHeaders = "Yes".
]]></help>
<values/>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Column width, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="font" required="false" type="String">
<help><![CDATA[
Font of data in column.
]]></help>
<values default="arial">
<value option="arial"/>
<value option="times"/>
<value option="courier"/>
<value option="arialunicodeMS"/>
</values>
</parameter>
<parameter name="fontsize" required="false" type="Numeric">
<help><![CDATA[
Size of text in column.
]]></help>
<values/>
</parameter>
<parameter name="italic" required="false" type="boolean">
<help><![CDATA[
Yes: displays grid control text in italics
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="bold" required="false" type="boolean">
<help><![CDATA[
Yes: displays grid control text in bold
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="bgcolor" required="false" type="String">
<help><![CDATA[
Background color of control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values>
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="textcolor" required="false" type="String">
<help><![CDATA[
Text color for control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values>
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="href" required="false" type="String">
<help><![CDATA[
URL o r query column name that contains a URL to hyperlink
each grid column with.
]]></help>
<values/>
</parameter>
<parameter name="hrefkey" required="false" type="String">
<help><![CDATA[
The query column to use for the value appended to the href
URL of each column, instead of the column's value.
]]></help>
<values/>
</parameter>
<parameter name="target" required="false" type="String">
<help><![CDATA[
Frame in which to open link specified in href.
]]></help>
<values/>
</parameter>
<parameter name="select" required="false" type="boolean">
<help><![CDATA[
Yes: user can select the column in grid control.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="display" required="false" type="boolean">
<help><![CDATA[
No: hides column
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
image: grid displays image that corresponds to value in
column (a built-in CFML image name, or an image in
cfide\classes directory or subdirectory referenced with
relative URL). If image is larger than column cell, it is
clipped to fit. Built-in image names
]]></help>
<values>
<value option="string_noCase"/>
<value option="Boolean"/>
<value option="numeric"/>
<value option="date"/>
<value option="combobox"/>
<value option="image"/>
</values>
</parameter>
<parameter name="headerfont" required="false" type="String">
<help><![CDATA[
Font of data in column.
]]></help>
<values/>
</parameter>
<parameter name="headerfontsize" required="false" type="Numeric">
<help><![CDATA[
Size of text in column.
]]></help>
<values/>
</parameter>
<parameter name="headeritalic" required="false" type="boolean">
<help><![CDATA[
Yes: displays grid control text in italics
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="headerbold" required="false" type="boolean">
<help><![CDATA[
Yes: displays grid control text in bold
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="headertextcolor" required="false" type="String">
<help><![CDATA[
Text color for control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values>
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="dataalign" required="false" type="String">
<help><![CDATA[
Column data alignment
]]></help>
<values>
<value option="left"/>
<value option="right"/>
<value option="center"/>
</values>
</parameter>
<parameter name="headeralign" required="false" type="String">
<help><![CDATA[
Column header text alignment
]]></help>
<values>
<value option="left"/>
<value option="right"/>
<value option="center"/>
</values>
</parameter>
<parameter name="numberformat" required="false" type="String">
<help><![CDATA[
Format for displaying numeric data in grid. See
numberFormat mask characters.
]]></help>
<values/>
</parameter>
<parameter name="values" required="false" type="String">
<help><![CDATA[
Formats cells in column as drop-down list boxes; specify
items in drop-down list. Example:
values = "arthur, scott, charles, 1-20, mabel"
]]></help>
<values/>
</parameter>
<parameter name="valuesdisplay" required="false" type="String">
<help><![CDATA[
Maps elements in values attribute to string to display in
drop-down list. Delimited strings and/or numeric range(s).
]]></help>
<values/>
</parameter>
<parameter name="valuesdelimiter" required="false" type="String">
<help><![CDATA[
Maps elements in values attribute to string to display in
drop-down list. Delimited strings and/or numeric range(s).
]]></help>
<values>
<value option=","/>
<value option=";"/>
<value option="|"/>
<value option=":"/>
</values>
</parameter>
<parameter name="mask" required="false" type="String">
<help><![CDATA[
A mask pattern that controls the character pattern
that the form displays or allows users to input and
sends to ColdFusion.
For currency type data, use currency symbol.
For text or numeric type data use:
- A = [A-Za-z]
- X = [A-Za-z0-9]
- 9 = [0-9]
- ? = Any character
- all other = the literal character
For date type data use datetime masks.
]]></help>
<values/>
</parameter>
<parameter name="headerIcon" required="false" type="String">
<help><![CDATA[
Header Icon for grid column
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>bgcolor,bold,dataalign,display,font,fontsize,header,headeralign,headerbold,headerfont,headerfontsize,headeritalic,headertextcolor,href,hrefkey,italic,mask,numberformat,select,target,textcolor,type,values,valuesdelimiter,valuesdisplay,width,headerIcon</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfgridrow
data = "col1, col2, ..."
-->
<tag endtagrequired="false" name="cfgridrow" single="true"
xmlstyle="false">
<help><![CDATA[
Lets you define a cfgrid that does not use a query as source
for row data. If a query attribute is specified in cfgrid, the
cfgridrow tags are ignored.
]]></help>
<parameter name="data" required="true" type="String">
<help><![CDATA[
Delimited list of column values. If a value contains a
comma, it must be escaped with another comma
]]></help>
<values/>
</parameter>
<parameter name="delimiter" required="false" type="String">
<help><![CDATA[
Delimiter to be used for data
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="data">
<required>data</required>
<optional/>
</combination>
</possiblecombinations>
</tag>
<!--
cfgridupdate
grid = "gridname"
dataSource = "data source name"
tableName = "table name"
username = "data source username"
password = "data source password"
tableOwner = "table owner"
tableQualifier = "qualifier"
keyOnly = "boolean"
-->
<tag endtagrequired="false" name="cfgridupdate" single="true"
xmlstyle="false">
<help><![CDATA[
Used within a cfgrid tag. Updates data sources directly from
edited grid data. This tag provides a direct interface with
your data source.
This tag applies delete row actions first, then insert row
actions, then update row actions. If it encounters an error,
it stops processing rows.
]]></help>
<parameter name="grid" required="true" type="String">
<help><![CDATA[
Name of cfgrid form element that is the source for the
update action.
]]></help>
<values/>
</parameter>
<parameter name="datasource" required="true" type="String">
<help><![CDATA[
Name of data source for the update action.
]]></help>
<values/>
</parameter>
<parameter name="tablename" required="true" type="String">
<help><![CDATA[
Table in which to insert form fields.
ORACLE drivers: must be uppercase.
Sybase driver: case-sensitive. Must be the same case used
when table was created
]]></help>
<values/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
Overrides username specified in ODBC setup.
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Overrides password specified in ODBC setup.
]]></help>
<values/>
</parameter>
<parameter name="tableowner" required="false" type="String">
<help><![CDATA[
Table owner, if supported.
]]></help>
<values/>
</parameter>
<parameter name="tablequalifier" required="false" type="String">
<help><![CDATA[
For data sources that support table qualifiers, use this
field to specify qualifier for table. The purpose of table
qualifiers varies among drivers. For SQL Server and
Oracle, qualifier refers to name of database that contains
table. For Intersolv dBASE driver, qualifier refers to
directory where DBF files are located.
]]></help>
<values/>
</parameter>
<parameter name="keyonly" required="false" type="boolean">
<help><![CDATA[
Applies to the update action:
Yes: the WHERE criteria are limited to the key values
No: the WHERE criteria include key values and the original
values of changed fields
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations>
<combination attributename="grid">
<required>dbtype,grid,tablename</required>
<optional>connectstring,datasource,dbname,dbpool,dbserver,keyonly,password,provider,providerdsn,tableowner,tablequalifier,username</optional>
</combination>
<combination attributename="grid">
<required>datasource,grid,tablename</required>
<optional>connectstring,dbname,dbpool,dbserver,dbtype,keyonly,password,provider,providerdsn,tableowner,tablequalifier,username</optional>
</combination>
<combination attributename="tablename">
<required>dbtype,grid,tablename</required>
<optional>connectstring,datasource,dbname,dbpool,dbserver,keyonly,password,provider,providerdsn,tableowner,tablequalifier,username</optional>
</combination>
<combination attributename="tablename">
<required>datasource,grid,tablename</required>
<optional>connectstring,dbname,dbpool,dbserver,dbtype,keyonly,password,provider,providerdsn,tableowner,tablequalifier,username</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfheader
name = "header_name"
value = "header_value"
charset="charset"
OR
cfheader
statusCode = "status_code"
statusText = "status_text"
-->
<tag endtagrequired="false" name="cfheader" single="true"
xmlstyle="false">
<help><![CDATA[
Generates custom HTTP response headers to return to the client.
]]></help>
<parameter name="name" required="false" type="String">
<help><![CDATA[
Header name
Required if statusCode not specified
]]></help>
<values/>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
HTTP header value
]]></help>
<values/>
</parameter>
<parameter name="charset" required="false" type="String">
<help><![CDATA[
The character encoding in which to encode the header value.
For more information on character encodings, see:
www.w3.org/International/O-charset.html.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
</parameter>
<parameter name="statuscode" required="false" type="Numeric">
<help><![CDATA[
HTTP status code
Required if name not specified
]]></help>
<values/>
</parameter>
<parameter name="statustext" required="false" type="String">
<help><![CDATA[
Explains status code
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfhtmlhead
text = "text"
-->
<tag endtagrequired="false" name="cfhtmlhead" single="true"
xmlstyle="false">
<help><![CDATA[
Writes text to the head section of a generated HTML page. It is
useful for embedding JavaScript code, or putting other HTML
tags, such as meta, link, title, or base in an HTML page
header.
]]></help>
<parameter name="text" required="true" type="String">
<help><![CDATA[
Text to add to the <head> area of an HTML page.
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="text">
<required>text</required>
<optional/>
</combination>
</possiblecombinations>
</tag>
<tag endtagrequired="false" hybrid="true" name="cfhttp"
single="false"
xmlstyle="false">
<help><![CDATA[
Generates an HTTP request and handles the response from the
server.
]]></help>
<return parameter="result" type="Struct"/>
<parameter name="url" required="true" type="URL">
<help><![CDATA[
Address of the resource on the server which will handle
the request. The URL must include the hostname or IP
address.
If you do not specify the transaction protocol (http:// or
https://), CFML defaults to http.
If you specify a port number in this attribute, it
overrides any port attribute value.
The cfhttppparam tag URL attribute appends query string
attribute-value pairs to the URL.
]]></help>
<values/>
</parameter>
<parameter name="port" required="false" type="Numeric">
<help><![CDATA[
Port number on the server to which to send the request.
A port value in the url attribute overrides this value.
(default: http 80 - https 443)
]]></help>
<values default="80"/>
</parameter>
<parameter isswitchattribute="true" name="method"
required="false" type="String">
<help><![CDATA[
* GET Requests information from the server. Any data that
the server requires to identify the requested
information must be in the URL or in cfhttp type="URL"
tags.
* POST Sends information to the server for processing.
Requires one or more cfhttpparam tags. Often used for
submitting form-like data.
* PUT Requests the server to store the message body at the
specified URL. Use this method to send files to the
server.
* DELETE Requests the server to delete the specified URL.
* HEAD Identical to the GET method, but the server does
not send a message body in the response. Use this
method for testing hypertext links for validity and
accessibility, determining the type or modification
time of a document, or determining the type of server.
* TRACE Requests that the server echo the received HTTP
headers back to the sender in the response body. Trace
requests cannot have bodies. This method enables the
CFML application to see what is being received
at the server, and use that data for testing or
diagnostic information.
* OPTIONS A request for information about the
communication options available for the server or the
specified URL. This method enables the CFML
application to determine the options and requirements
associated with a URL, or the capabilities of a server,
without requesting any additional activity by the
server.
]]></help>
<values default="get">
<value option="get"/>
<value option="post"/>
<value option="put"/>
<value option="delete"/>
<value option="head"/>
<value option="trace"/>
<value option="options"/>
</values>
</parameter>
<parameter name="proxyserver" required="false" type="String">
<help><![CDATA[
The proxy server required to access the URL.
]]></help>
<values/>
</parameter>
<parameter name="proxyport" required="false" type="Numeric">
<help><![CDATA[
The port to use on The proxy server.
]]></help>
<values default="80"/>
</parameter>
<parameter name="proxyuser" required="false" type="String">
<help><![CDATA[
The user ID to send to the proxy server.
]]></help>
<values/>
</parameter>
<parameter name="proxypassword" required="false" type="String">
<help><![CDATA[
The user's password on the proxy server.
]]></help>
<values/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
A username. May be required by server.
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
A password. May be required by server
]]></help>
<values/>
</parameter>
<parameter name="useragent" required="false" type="String">
<help><![CDATA[
Text to put in the user agent request header. Used to
identify the request client software. Can make the
CFML application appear to be a browser.
]]></help>
<values default="ColdFusion"/>
</parameter>
<parameter name="charset" required="false" type="String">
<help><![CDATA[
TThe character encoding of the request, including the URL
query string and form or file data, and the response.
For more information on character encodings, see:
www.w3.org/International/O-charset.html.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
</parameter>
<parameter name="resolveurl" required="false" type="boolean">
<help><![CDATA[
No does not resolve URLs in the response body. As a result,
any relative URL links in the response body do not work.
Yes resolves URLs in the response body to absolute URLs,
including the port number, so that links in a retrieved
page remain functional.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="throwonerror" required="false" type="boolean">
<help><![CDATA[
Yes if the server returns an error response code, throws
an exception that can be caught using the cftry and
cfcatch or CFML error pages.
No does not throw an exception if an error response is
returned. In this case, your application can use the
cfhttp.StatusCode variable to determine if there was
an error and its cause.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="redirect" required="false" type="boolean">
<help><![CDATA[
If the response header includes a Location field,
determines whether to redirect execution to the URL
specified in the field.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="timeout" required="false" type="Numeric">
<help><![CDATA[
Value, in seconds of the maximum time the request can take.
If the timeout passes without a response, CFML
considers the request to have failed.
]]></help>
<values/>
</parameter>
<parameter name="getasbinary" required="false" type="String">
<help><![CDATA[
* No If CFML does not recognize the response body
type as text, convert it to a CFML object.
* Auto If CFML does not recognize the response body
type as text, convert it to CFML Binary type data.
* Yes Always convert the response body content into
CFML Binary type data, even if CFML
recognizes the response body type as text.
]]></help>
<values default="auto">
<value option="auto"/>
<value option="false"/>
<value option="true"/>
</values>
</parameter>
<parameter name="result" required="false" returnVarType="Struct" type="String">
<help><![CDATA[
Specifies the name of the variable in which you want
the result returned.
Default: CFHTTP
]]></help>
<values default="cfhttp"/>
</parameter>
<parameter name="delimiter" required="false" type="String">
<help><![CDATA[
A character that separates query columns. The response body must use this character to separate the query columns.
]]></help>
<values>
<value option=","/>
<value option=";"/>
<value option="|"/>
<value option=":"/>
</values>
</parameter>
<parameter name="name" required="false" returnVarType="query" type="String">
<!-- VariableName -->
<help><![CDATA[
Tells ColdFusion to create a query object with the given
name from the returned HTTP response body.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="method"
required="false" value="get"/>
<selectedValue attributeName="method"
required="false" value="post"/>
</triggers>
</parameter>
<parameter name="columns" required="false" type="String">
<help><![CDATA[
The column names for the query, separated by commas, with no
spaces. Column names must start with a letter. The remaining
characters can be letters, numbers, or underscore
characters (_).
If there are no column name headers in the response,
specify this attribute to identify the column names.
If you specify this attribute, and the firstrowasHeader
attribute is True (the default), the column names specified
by this attribute replace the first line of the response.
You can use this behavior to replace the column names
retrieved by the request with your own names.
If a duplicate column heading is encountered in either this
attribute or in the column names from the response,
ColdFusion appends an underscore to the name to make it
unique.
If the number of columns specified by this attribute does
not equal the number of columns in the HTTP response body,
ColdFusion generates an error.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="method"
required="false" value="get"/>
<selectedValue attributeName="method"
required="false" value="post"/>
</triggers>
</parameter>
<parameter name="firstrowasheaders" required="false" type="boolean">
<help><![CDATA[
Determines how ColdFusion processes the first row of the
query record set:
* yes: processes the first row as column heads. If you
specify a columns attribute, ColdFusion ignores the
first row of the file.
* no: processes the first row as data. If you do not
specify a columns attribute, ColdFusion generates column
names by appending numbers to the word "column"; for
example, "column_1".
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="method"
required="false" value="get"/>
<selectedValue attributeName="method"
required="false" value="post"/>
</triggers>
</parameter>
<parameter name="textqualifier" required="false" type="String">
<help><![CDATA[
A character that, optionally, specifies the start and end
of a text column. This character must surround any text
fields in the response body that contain the delimiter
character as part of the field value.
To include this character in column text, escape it by
using two characters in place of one. For example, if the
qualifier is a double-quotation mark, escape it as "".
]]></help>
<values default=""">
<value option="""/>
<value option="'"/>
</values>
<triggers>
<selectedValue attributeName="method"
required="false" value="get"/>
<selectedValue attributeName="method"
required="false" value="post"/>
</triggers>
</parameter>
<parameter name="file" required="false" type="String">
<help><![CDATA[
Name of the file in which to store the response body.
]]></help>
</parameter>
<parameter name="multipart" required="false" type="Boolean">
<help><![CDATA[
Tells ColdFusion to send all data specified by cfhttpparam type="formField" tags as multipart form data, with a Content-Type of multipart/form-data.
]]></help>
<values default="false">
<value option="false"/>
<value option="true"/>
</values>
</parameter>
<parameter name="clientcertpassword" required="false" type="String">
<help><![CDATA[
Password used to decrypt the client certificate.
]]></help>
</parameter>
<parameter name="path" required="false" type="String">
<help><![CDATA[
Required if File is specified. Tells ColdFusion to save the HTTP response body in a file. Contains the absolute path to the directory in which to store the file.
]]></help>
</parameter>
<parameter name="clientcert" required="false" type="String">
<help><![CDATA[
The full path to a PKCS12 format file that contains the client certificate for the request.
]]></help>
</parameter>
<parameter name="compression" required="false" type="String">
<help><![CDATA[
Compression type
]]></help>
</parameter>
<possiblecombinations>
<combination switchvalue="get">
<required>url</required>
<optional>charset,clientcert,clientcertpassword,columns,delimiter,file,firstrowasheaders,getasbinary,method,name,password,path,port,proxypassword,proxyport,proxyserver,proxyuser,redirect,resolveurl,result,textqualifier,throwonerror,timeout,useragent,username,compression</optional>
</combination>
<combination switchvalue="put">
<required>url</required>
<optional>charset,clientcert,clientcertpassword,file,method,name,password,path,port,proxypassword,proxyport,proxyserver,proxyuser,redirect,resolveurl,result,textqualifier,throwonerror,timeout,useragent,username,compression</optional>
</combination>
<combination switchvalue="head">
<required>url</required>
<optional>charset,clientcert,clientcertpassword,getasbinary,method,password,port,proxypassword,proxyport,proxyserver,proxyuser,redirect,resolveurl,result,throwonerror,timeout,useragent,username,compression</optional>
</combination>
<combination switchvalue="delete">
<required>url</required>
<optional>charset,clientcert,clientcertpassword,getasbinary,file,method,password,path,port,proxypassword,proxyport,proxyserver,proxyuser,redirect,resolveurl,result,throwonerror,timeout,useragent,username,compression</optional>
</combination>
<combination switchvalue="trace">
<required>url</required>
<optional>charset,clientcert,clientcertpassword,file,method,name,password,path,port,proxypassword,proxyport,proxyserver,proxyuser,redirect,resolveurl,result,textqualifier,throwonerror,timeout,useragent,username,compression</optional>
</combination>
<combination switchvalue="post">
<required>url</required>
<optional>charset,clientcert,clientcertpassword,columns,delimiter,file,firstrowasheaders,getasbinary,method,multipart,name,password,path,port,proxypassword,proxyport,proxyserver,proxyuser,redirect,resolveurl,result,textqualifier,throwonerror,timeout,useragent,username,compression</optional>
</combination>
<combination switchvalue="options">
<required>url</required>
<optional>charset,clientcert,clientcertpassword,getasbinary,file,method,name,password,path,port,proxypassword,proxyport,proxyserver,proxyuser,redirect,resolveurl,result,textqualifier,throwonerror,timeout,useragent,username,compression</optional>
</combination>
</possiblecombinations>
</tag>
<tag endtagrequired="false" name="cfhttpparam" single="true"
xmlstyle="false">
<help><![CDATA[
Allowed inside cfhttp tag bodies only. Required for cfhttp POST
operations. Optional for all others. Specifies parameters to
build an HTTP request.
]]></help>
<parameter isswitchattribute="true" name="type"
required="true" type="String">
<help><![CDATA[
Information type
* Header: The parameter specifies an HTTP header.
(ColdFusion does not URL encode the header)
* Body: Specifies the body of the HTTP request.
(ColdFusion does not URL encode the body contents)
* XML: Identifies the request as having a content-type of
text/xml. Specifies that the value attribute contains
the body of the HTTP request. Used to send XML to the
destination URL. CFML does not URL encode the XML
data.
* CGI: Specifies an HTTP header. CFML URL encodes
the header by default.
* File: Tells CFML to send the contents of the
specified file. CFML does not URL encode the
file contents
* URL: Specifies a URL query string name-value pair to
append to the cfhttp url attribute. CFML URL
encodes the query string.
* FormField: Specifies a form field to send. CFML
URL encodes the Form field by default.
* Cookie: Specifies a cookie to send as an HTTP header.
CFML URL encodes the cookie.
]]></help>
<values>
<value option="header"/>
<value option="body"/>
<value option="xml"/>
<value option="cgi"/>
<value option="file"/>
<value option="url"/>
<value option="formfield"/>
<value option="cookie"/>
</values>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
Variable name for data that is passed. Ignored for Body
and XML types. For File type, specifies the filename to
send in the request.
]]></help>
<values/>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
Value of the data that is sent. Ignored for File type. The
value must contain string data or data that CFML can
convert to a string for all type attributes except Body.
Body types can have string or binary values.
]]></help>
<values/>
</parameter>
<parameter name="file" required="false" type="String">
<help><![CDATA[
Applies to File type; ignored for all other types. The
absolute path to the file that is sent in the request body.
]]></help>
<values/>
</parameter>
<parameter name="encoded" required="false" type="boolean">
<help><![CDATA[
Applies to FormField and CGI types; ignored for all other
types. Specifies whether to URLEncode the form field or
header.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="mimetype" required="false" type="String">
<help><![CDATA[
Applies to File type; invalid for all other types.
Specifies the MIME media type of the file contents.
The content type can include an identifier for the
character encoding of the file; for example, text/html;
charset=ISO-8859-1 indicates that the file is HTML text in
the ISO Latin-1 character encoding.
]]></help>
<values>
<value option="text/plain"/>
<value option="text/html"/>
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="body">
<required>value</required>
<optional>name</optional>
</combination>
<combination switchvalue="cookie">
<required>name,value</required>
<optional/>
</combination>
<combination switchvalue="cgi">
<required>name,value</required>
<optional>encoded</optional>
</combination>
<combination switchvalue="file">
<required>file,name</required>
<optional>mimetype</optional>
</combination>
<combination switchvalue="header">
<required>name,value</required>
<optional/>
</combination>
<combination switchvalue="formfield">
<required>name,value</required>
<optional>encoded</optional>
</combination>
<combination switchvalue="url">
<required>name,value</required>
<optional/>
</combination>
<combination switchvalue="xml">
<required>value</required>
<optional/>
</combination>
</possiblecombinations>
</tag>
<!--
cfif expression
[HTML and CFML tags]
/cfif
-->
<tag endtagrequired="true" canHaveAttributeCollection="false" name="cfif" single="false"
xmlstyle="false">
<help><![CDATA[
Creates simple and compound conditional statements in CFML.
Tests an expression, variable, function return value, or
string. Used, optionally, with the cfelse and cfelseif tags.
]]></help>
</tag>
<tag endtagrequired="true" canHaveAttributeCollection="false" name="cffinally" single="false"
xmlstyle="false">
<help><![CDATA[
Used inside a cftry tag. Code in the cffinally block is processed after the main cftry code and, if an exception
occurs, the cfcatch code. The cffinally block code always executes, whether or not there is an exception.
]]></help>
</tag>
<tag endtagrequired="false" canHaveAttributeCollection="false" name="cfcontinue" single="false"
xmlstyle="false">
<help><![CDATA[
Used within a cfloop tag. Returns processing to the top of a loop.
]]></help>
</tag>
<tag name="cfimap" single="true" xmlstyle="false">
<help><![CDATA[
Queries an IMAP server to retrieve and manage mails within multiple folders.
]]></help>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Specifies the password for assessing the users’ e-mail account.
]]></help>
</parameter>
<parameter name="secure" required="false" type="Boolean">
<help><![CDATA[
Specifies whether the IMAP server uses a Secure Sockets Layer.
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter isswitchattribute="true" name="action"
required="false" type="String">
<help><![CDATA[
* GetHeaderOnly - Returns the message header information for all retrieved mail.
* GetAll - Returns mail. The information includes the message header information, message text, and any attachments. Set the AttachmentPath attribute to retrieve attachments.
* Delete - Deletes messages from a folder.
* Open - Initiates an open session or connection with the IMAP server.
* Close - Terminates the open session or connection with the IMAP server.
* MarkRead - Marks all messages read from a folder.
* DeleteFolder - Deletes the identified folder.
* CreateFolder - Creates a folder in Inbox.
* RenameFolder - Renames an existing user-defined folder.
* ListAllFolders - Displays a list of all existing folders in the mailbox or under the folder name defined by the Folder attribute.
* MoveMail - Moves mail from one folder to another
]]></help>
<values default="getheaderonly">
<value option="createfolder"/>
<value option="open"/>
<value option="close"/>
<value option="getall"/>
<value option="markread"/>
<value option="listallfolders"/>
<value option="getheaderonly"/>
<value option="deletefolder"/>
<value option="delete"/>
<value option="renamefolder"/>
<value option="movemail"/>
</values>
</parameter>
<parameter name="timeout" required="false" type="Numeric">
<help><![CDATA[
Specifies the number of seconds to wait before timing out connection to IMAP server. An error message is displayed when timeout occurs.
]]></help>
</parameter>
<parameter name="messageNumber" required="false" type="String">
<help><![CDATA[
Specifies the message number or a comma delimited list of message numbers for retrieval, deletion, marking mail as read, or moving mails.
If you set an invalid message number or range, then it is ignored. If you have specified the UID attribute, then MessageNumber attribute is ignored.
]]></help>
</parameter>
<parameter name="connection" required="false" type="String">
<help><![CDATA[
Required for the following actions: Open and Close - Specifies the variable name for the connection/session. For example, the e-mail login to an IMAP server can be used as the value for the connection. If the server attribute has an invalid IP address or invalid domain name,
then the connection fails and ColdFusion returns an error message.
]]></help>
</parameter>
<parameter name="newFolder" required="false" type="String">
<help><![CDATA[
Specifies the name of the destination folder where all mail move.
]]></help>
</parameter>
<parameter name="uid" required="false" type="String">
<help><![CDATA[
Specifies the unique ID or a comma-delimited list of Uids to retrieve or delete. If you set invalid Uids, then they are ignored.
]]></help>
</parameter>
<parameter name="folder" required="false" type="String">
<help><![CDATA[
For mail actions: Specifies the folder name where messages are searched, retrieved, moved, or deleted. If folder name is invalid, ColdFusion defaults to INBOX.
For folder actions: Specifies the folder name that is deleted (DeleteFolder) or created (CreateFolder) or renamed (RenameFolder).
]]></help>
</parameter>
<parameter name="port" required="false" type="Numeric">
<help><![CDATA[
Specifies the IMAP port number. Use 993 for secured connections.
]]></help>
</parameter>
<parameter name="stoponerror" required="false" type="Boolean">
<help><![CDATA[
Specifies whether or not to ignore the exceptions for this operation. When the value is true, it stops processing, displays an appropriate error.
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="generateUniqueFileNames" required="false" type="Boolean">
<help><![CDATA[
Ensures that unique file names are generated for each attachment file.
The goal is to avoid name conflicts for attachments that have the same filename.
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="maxrows" required="false" type="Numeric">
<help><![CDATA[
Specifies the number of rows to be marked as read, deleted, or moved across folders. When the value is 1, it signals the row determined by StartRow. Any incremental value marks rows starting from the StartRow.
If you have specified the UID or MessageNumber attribute, then MaxRows is ignored.
]]></help>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
Specifies the user name. Typically, the user name is same the e-mail login.
]]></help>
</parameter>
<parameter name="startRow" required="false" type="Numeric">
<help><![CDATA[
Defines the first row number for reading or deleting. If you have specified the UID or MessageNumber attribute, then StartRow is ignored. You can also specify StartRow for moving mails.
]]></help>
</parameter>
<parameter name="attachmentpath" required="false" type="String">
<help><![CDATA[
Required for GetAll action - Specifies the name of the folder where ColdFusion retrieves attachments. If this folder does not exist, ColdFusion creates it.
]]></help>
</parameter>
<parameter name="server" required="false" type="String">
<help><![CDATA[
Specifies the IMAP server identifier. You can assign a host name or an IP address as the IMAP server identifier. For example, imap.gmail.com.
]]></help>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
Specifies the name for the query object that contains the retrieved message information.
]]></help>
</parameter>
<parameter name="recurse" required="false" type="Boolean">
<help><![CDATA[
Specifies whether ColdFusion runs the CFIMAP command in subfolders.
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="createfolder">
<required>folder</required>
<optional>connection,password,port,secure,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="open">
<required>connection,server</required>
<optional>password,port,secure,timeout,username</optional>
</combination>
<combination switchvalue="close">
<required>connection</required>
<optional/>
</combination>
<combination switchvalue="getall">
<required>name</required>
<optional>attachmentpath,connection,folder,generateuniquefilenames,maxrows,messagenumber,password,port,secure,server,startrow,stoponerror,timeout,uid,username</optional>
</combination>
<combination switchvalue="markread">
<required/>
<optional>connection,folder,maxrows,messagenumber,password,port,secure,server,startrow,stoponerror,timeout,uid,username</optional>
</combination>
<combination switchvalue="listallfolders">
<required/>
<optional>connection,folder,password,port,recurse,secure,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="getheaderonly">
<required>name</required>
<optional>action,connection,folder,maxrows,messagenumber,password,port,secure,server,startrow,stoponerror,timeout,uid,username</optional>
</combination>
<combination switchvalue="deletefolder">
<required>folder</required>
<optional>connection,password,port,secure,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="delete">
<required/>
<optional>connection,folder,maxrows,messagenumber,password,port,secure,server,startrow,stoponerror,timeout,uid,username</optional>
</combination>
<combination switchvalue="renamefolder">
<required>folder,newfolder</required>
<optional>connection,password,port,secure,server,stoponerror,timeout,username</optional>
</combination>
<combination switchvalue="movemail">
<required>newfolder</required>
<optional>connection,folder,maxrows,messagenumber,password,port,secure,server,startrow,stoponerror,timeout,uid,username</optional>
</combination>
</possiblecombinations>
</tag>
<tag endtagrequired="false" canHaveAttributeCollection="false" name="cfimport" single="true"
xmlstyle="false">
<help><![CDATA[
You can use the cfimport tag to import either of the following:
* All CFML pages in a directory, as a tag custom tag
library.
* A Java Server Page (JSP) tag library. A JSP tag library is a
packaged set of tag handlers that conform to the JSP 1.1 tag
extension API.
]]></help>
<parameter name="taglib" required="false" type="String">
<help><![CDATA[
Tag library URI. The path must be relative to the web root
(and start with /), the current page location, or a
directory specified in the Administrator CFML
mappings page.
A directory in which custom CFML tags are stored. In
this case, all the cfm pages in this directory are treated
as custom tags in a tag library.
A path to a JAR in a web-application; for example,
"/WEB-INF/lib/sometags.jar"
A path to a tag library descriptor; for example,
"/sometags.tld"
Note: You must put JSP custom tag libraries in the
/WEB-IN/lib directory. This limitation does not apply to
CFML pages.
]]></help>
<values/>
</parameter>
<parameter name="prefix" required="false" type="String">
<help><![CDATA[
Prefix by which to access the imported custom CFML tags JSP
tags.
If you import a CFML custom tag directory and specify an
empty value, "", for this attribute, you can call the
custom tags without using a prefix. You must specify and
use a prefix for a JSP tag library.
]]></help>
<values/>
</parameter>
<parameter name="path" required="false" type="String">
<help><![CDATA[
path of CFC to be imported
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="taglib">
<required>taglib</required>
<optional>prefix</optional>
</combination>
<combination attributename="path">
<required>path</required>
<optional></optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfinclude
template = "template_name"
-->
<tag endtagrequired="false" hybrid="true" name="cfinclude"
single="true"
xmlstyle="false">
<help><![CDATA[
Embeds references to CFML pages in CFML. You can embed
cfinclude tags recursively. For another way to encapsulate
CFML, see cfmodule. (A CFML page was formerly sometimes
called a CFML template or a template.)
]]></help>
<parameter name="template" required="true" type="String">
<help><![CDATA[
A logical path to a CFML page.
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="template">
<required>template</required>
<optional/>
</combination>
</possiblecombinations>
</tag>
<!--
cfindex
collection = "collection_name"
action = "action"
type = "type"
title = "title"
key = "ID"
body = "body"
custom1 = "custom_value"
custom2 = "custom_value"
custom3 = "custom_value"
custom4 = "custom_value"
category = "category name"
categoryTree = "category tree"
URLpath = "URL"
extensions = "file_extensions"
query = "query_name"
recurse = "boolean"
language = "language"
status = "status"
-->
<tag endtagrequired="false" name="cfindex" single="true"
xmlstyle="false">
<help><![CDATA[
Populates a Verity search engine collection with an index of
documents on a file system or of CFML query result sets.
A collection must exist before it can be populated.
]]></help>
<parameter name="collection" required="true" type="String">
<help><![CDATA[
Name of a collection that is registered by CFML; for
example, "personnel"
Name and absolute path of a collection that is not
registered by CFML; for example:
"e:\collections\personnel"
]]></help>
<values/>
</parameter>
<parameter isswitchattribute="true" name="action"
required="false" type="String">
<help><![CDATA[
- update: updates a collection and adds key to the index.
- delete: removes collection documents as specified by
the key attribute.
- purge: deletes all of the documents in a collection.
Causes the collection to be taken offline, preventing
searches.
- refresh: deletes all of the documents in a collection,
and then performs an update.
]]></help>
<values>
<value option="update"/>
<value option="delete"/>
<value option="purge"/>
<value option="refresh"/>
</values>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
file: using the key attribute value of the query result as
input, applies action value to filenames or filepaths.
path: using the key attribute value of the query result as
input, applies action to filenames or filepaths that
pass the extensions filter
custom: If action = "update" or "delete": applies action to
custom entities in query results.
]]></help>
<values>
<value option="file"/>
<value option="path"/>
<value option="custom"/>
</values>
</parameter>
<parameter name="title" required="false" type="String">
<help><![CDATA[
* Title for collection
* Query column name for type and a valid query name
Permits searching collections by title or displaying a
separate title from the key
]]></help>
<values/>
</parameter>
<parameter name="key" required="false" type="String">
<help><![CDATA[
* Absolute path and filename, if type = "file"
* Absolute path, if type = "path"
* A query column name (typically, the primary key column
name), if type = "custom"
* A query column name, if type = any other value
This attribute is required for the actions listed, unless
you intend for its value to be an empty string.
]]></help>
<values/>
</parameter>
<parameter name="body" required="false" type="String">
<help><![CDATA[
* ASCII text to index
* Query column name(s), if name is specified in query
You can specify columns in a delimited list. For example:
"emp_name, dept_name, location"
]]></help>
<values/>
</parameter>
<parameter name="custom1" required="false" type="String">
<help><![CDATA[
Custom field in which you can store data during an indexing
operation. Specify a query column name for type, and a
query name.
]]></help>
<values/>
</parameter>
<parameter name="custom2" required="false" type="String">
<help><![CDATA[
Custom field in which you can store data during an indexing
operation. Specify a query column name for type, and a
query name.
]]></help>
<values/>
</parameter>
<parameter name="custom3" required="false" type="String">
<help><![CDATA[
Custom field in which you can store data during an indexing
operation. Specify a query column name for type, and a
query name. (Added in ColdFusion 7)
]]></help>
<values/>
</parameter>
<parameter name="custom4" required="false" type="String">
<help><![CDATA[
Custom field in which you can store data during an indexing
operation. Specify a query column name for type, and a
query name. (Added in ColdFusion 7)
]]></help>
<values/>
</parameter>
<parameter name="category" required="false" type="String">
<help><![CDATA[
A string value that specifies one or more search categories
for which to index the data. You can define multiple
categories, separated by commas, for a single index.
]]></help>
<values/>
</parameter>
<parameter name="categoryTree" required="false" type="String">
<help><![CDATA[
A string value that specifies a hierarchical category or
category tree for searching. It is a series of categories
separated by forward slashes ("/"). You can specify only
one category tree.
]]></help>
<values/>
</parameter>
<parameter name="urlpath" required="false" type="URL">
<help><![CDATA[
If type="file" or "path", specifies the URL path. When the
collection is searched with cfsearch, this pathname is
prefixed to filenames and returned as the url attribute.
]]></help>
<values/>
</parameter>
<parameter name="extensions" required="false" type="String">
<help><![CDATA[
Delimited list of file extensions that CFML uses to
index files, if type = "Path".
"*." returns files with no extension.
For example: the following code returns files with a
listed extension or no extension:
extensions = ".htm, .html, .cfm, .cfml, "*."
]]></help>
<values/>
</parameter>
<parameter name="query" required="false" type="query">
<help><![CDATA[
Query against which collection is generated
]]></help>
<values/>
</parameter>
<parameter name="recurse" required="false" type="boolean">
<help><![CDATA[
Yes: if type = "path", directories below the path
specified in key are included in indexing operation
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="language" required="false" type="String">
<help><![CDATA[
For options, see cfcollection. Requires the appropriate
Verity Locales language pack (Western Europe, Asia,
Multilanguage, Eastern Europe/Middle Eastern).
]]></help>
<values default="english"/>
</parameter>
<parameter name="status" required="false" type="String">
<help><![CDATA[
The name of the structure into which ColdFusion MX
returns status information.
]]></help>
<values/>
</parameter>
<parameter name="prefix" required="false" type="String">
<help><![CDATA[
Specifies the location of files to index when the computer that contains the K2 Search Service is not the computer on which you installed ColdFusion, and when you index files with the type attribute set to path.
]]></help>
</parameter>
<possiblecombinations>
<combination switchvalue="purge">
<required>collection</required>
<optional>status</optional>
</combination>
<combination switchvalue="update">
<required>collection,key</required>
<optional>body,category,categorytree,custom1,custom2,custom3,custom4,extensions,language,prefix,query,recurse,status,title,type,urlpath</optional>
</combination>
<combination switchvalue="optimize">
<required>collection</required>
<optional/>
</combination>
<combination switchvalue="delete">
<required>collection,key</required>
<optional>query,status,type</optional>
</combination>
<combination switchvalue="refresh">
<required>collection,key</required>
<optional>body,category,categorytree,custom1,custom2,custom3,custom4,extensions,language,prefix,query,recurse,status,title,type,urlpath</optional>
</combination>
</possiblecombinations>
</tag>
<tag endtagrequired="false" name="cfinput" single="true"
xmlstyle="false">
<help><![CDATA[
Used within the cfform tag, to place radio buttons, check boxes,
or text boxes on a form. Provides input validation for the
specified control type.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Name for form input element.
]]></help>
<values/>
</parameter>
<parameter name="autosuggest" required="false" type="String">
<help><![CDATA[
Specifies entry completion suggestions to
display as the user types into a text input. The
user can select a suggestion to complete the text
entry.
The valid value can be either of the following:
• A string consisting of the suggestion values
separated by the delimiter specified by the
delimiter attribute.
• A bind expression that gets the suggestion
values based on the current input text.
Valid only for cfinput type="text".
]]></help>
<values/>
</parameter>
<parameter name="autoSuggestBindDelay" required="false" type="Numeric">
<help><![CDATA[
The minimum time between autosuggest bind
expression invocations, in seconds. Use this
attribute to limit the number of requests that are
sent to the server when a user types.
Valid only for cfinput type="text"
]]></help>
<values/>
</parameter>
<parameter name="autoSuggestMinLength" required="false" type="Numeric">
<help><![CDATA[
The minimum number of characters required in
the text box before invoking a bind expression to
return items for suggestion.
Valid only for cfinput type="text".
]]></help>
<values/>
</parameter>
<parameter name="bindAttribute" required="false" type="String">
<help><![CDATA[
Specifies the HTML tag attribute whose value is
set by the bind attribute. You can only specify
attributes in the browser’s HTML DOM tree, not
ColdFusion-specific attributes.
Ignored if there is no bind attribute.
Valid only for cfinput type="text".
]]></help>
<values/>
</parameter>
<parameter name="bindonload" required="false" type="boolean">
<help><![CDATA[
A Boolean value that specifies whether to
execute the bind attribute expression when first
loading the form.
Ignored if there is no bind attribute.
Valid only for cfinput type="text".
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="id" required="false" type="String">
<help><![CDATA[
ID for form input element.
]]></help>
<values/>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
The input control type to create:
- button: push button.
- checkbox: check box.
- file: file selector; not supported in Flash.
- hidden: invisible control.
- image: clickable button with an image.
- password: password entry control; hides input values.
- radio: radio button.
- reset: form reset button.
- submit: form submission button.
- text: text entry box.
- datefield: Flash only; date entry field with an
expanding calendar for selecting dates.
]]></help>
<values default="text">
<value option="button"/>
<value option="checkbox"/>
<value option="file"/>
<value option="hidden"/>
<value option="image"/>
<value option="password"/>
<value option="radio"/>
<value option="reset"/>
<value option="submit"/>
<value option="text"/>
<value option="datefield"/>
<value option="autosuggest"/>
</values>
</parameter>
<parameter name="label" required="false" type="String">
<help><![CDATA[
Label to put next to the control on a Flash or XML form.
Not used for button, hidden, image, reset, or submit types.
]]></help>
<values/>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
In HTML or XML format, ColdFusion passes the style attribute
to the browser or XML.
In Flash format, must be a style specification in CSS format.
]]></help>
<values/>
</parameter>
<parameter name="class" required="false" type="String">
<help><![CDATA[
Stylesheet class for form input element.
]]></help>
<values/>
</parameter>
<parameter name="required" required="false" type="boolean">
<help><![CDATA[
* yes: the field must contain data.
* no: allows an empty field.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="mask" required="false" type="String">
<help><![CDATA[
A mask pattern that controls the character pattern that
users can enter, or that the form sends to ColdFusion.
In HTML and Flash for type=text use:
- A = [A-Za-z]
- X = [A-Za-z0-9]
- 9 = [0-9]
- ? = Any character
- all other = the literal character
In Flash for type=datefield use:
- D = day; can use 0-2 mask characters.
- M = month; can use 0-4 mask characters.
- Y = year; can use 0, 2, or 4 characters.
- E = day in week; can use 0-4 characters.
]]></help>
<values/>
</parameter>
<parameter name="validate" required="false" type="String">
<help><![CDATA[
date: verifies format mm/dd/yy.
eurodate: verifies date format dd/mm/yyyy.
time: verifies time format hh:mm:ss.
float: verifies floating point format.
integer: verifies integer format.
telephone: verifies telephone format ###-###-####. The
separator can be a blank. Area code and exchange must
begin with digit 1 - 9.
zipcode: verifies, in U.S. formats only, 5- or 9-digit
format #####-####. The separator can be a blank.
creditcard: strips blanks and dashes; verifies number using
mod10 algorithm. Number must have 13-16 digits.
social_security_number: verifies format ###-##-####. The
separator can be a blank.
regular_expression: matches input against pattern
attribute.
]]></help>
<values>
<value option="date"/>
<value option="eurodate"/>
<value option="time"/>
<value option="float"/>
<value option="integer"/>
<value option="telephone"/>
<value option="zipcode"/>
<value option="creditcard"/>
<value option="social_security_number"/>
<value option="regular_expression"/>
</values>
</parameter>
<parameter name="validateat" required="false" type="String">
<help><![CDATA[
How to do the validation; one or more of the following:
onSubmit, onServer or onBlur.
onBlur and onSubmit are identical in Flash forms. For
multiple values, use a comma-delimited list.
Default: onSubmit
]]></help>
<values default="onSubmit">
<value option="onSubmit"/>
<value option="onServer"/>
<value option="onBlur"/>
</values>
</parameter>
<parameter name="message" required="false" type="String">
<help><![CDATA[
Message text to display if validation fails
]]></help>
<values/>
</parameter>
<parameter name="range" required="false" type="String">
<help><![CDATA[
Minimum and maximum value range, separated by a comma. If
type = "text" or "password", this applies only to numeric
data.
]]></help>
<values/>
</parameter>
<parameter name="maxlength" required="false" type="Numeric">
<help><![CDATA[
Maximum length of text entered, if type=text or password.
]]></help>
<values/>
</parameter>
<parameter name="pattern" required="false" type="Regex">
<help><![CDATA[
JavaScript regular expression pattern to validate input.
ColdFusion uses this attribute only if you specify regex
in the validate attribute. Omit leading and trailing slashes.
]]></help>
<values/>
</parameter>
<parameter name="onvalidate" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to validate user input. The form
object, input object, and input object values are passed
to the routine, which should return True if validation
succeeds, and False otherwise. If used, the validate
attribute is ignored.
]]></help>
<values/>
</parameter>
<parameter name="onerror" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to execute if validation fails.
]]></help>
<values/>
</parameter>
<parameter name="size" required="false" type="Numeric">
<help><![CDATA[
Size of input control. Ignored, if type=radio or checkbox.
If specified in a Flash form, ColdFusion sets the control
width pixel value to 10 times the specified size and
ignores the width attribute.
]]></help>
<values/>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
HTML: corresponds to the HTML value attribute. Its use
depends on control type.
Flash: optional; specifies text for button type inputs:
button, submit, and image.
]]></help>
<values/>
</parameter>
<parameter name="bind" required="false" type="String">
<help><![CDATA[
A Flash bind expression that populates the field with
information from other form fields.
]]></help>
<values/>
</parameter>
<parameter name="checked" required="false" type="boolean">
<help><![CDATA[
Selects a control. No value is required. Applies if
type=radio or checkbox.
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="disabled" required="false" type="boolean">
<help><![CDATA[
Disables user input, making the control read-only. To
disable input, specify disabled without an attribute or
disabled="true". To enable input, omit the attribute
or specify disabled="false".
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="src" required="false" type="String">
<help><![CDATA[
Applies to Flash button, reset, submit, and image types,
and the HTML image type. URL of an image to use on
the button. Flash does not support GIF images.
]]></help>
<values/>
</parameter>
<parameter name="onkeyup" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash) to run
when the user releases a keyboard key in the control.
]]></help>
<values/>
</parameter>
<parameter name="onkeydown" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash)
ActionScript to run when the user presses a keyboard
key in the control.
]]></help>
<values/>
</parameter>
<parameter name="onmouseup" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash) to run
when the user presses a mouse button in the control.
]]></help>
<values/>
</parameter>
<parameter name="onmousedown" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash) to run
when the user releases a mouse button in the control.
]]></help>
<values/>
</parameter>
<parameter name="onchange" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash) to run
when the control changes due to user action. In Flash,
applies to datefield, password, and text types only.
]]></help>
<values/>
</parameter>
<parameter name="onclick" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash) to run
when the user clicks the control. In Flash, applies to
button, checkbox, image, radio, reset, and submit types
only.
]]></help>
<values/>
</parameter>
<parameter name="daynames" required="false" type="String">
<help><![CDATA[
A comma-delimited list that sets the names of the
weekdays displayed in the calendar. Sunday is the
first day and the rest of the weekday names follow in
the normal order.
Default is: S,M,T,W,Th,F,S
]]></help>
<values >
<value option="S" />
<value option="M" />
<value option="T" />
<value option="W" />
<value option="Th" />
<value option="F" />
<value option="Sa" />
<value option="Sunday" />
<value option="Monday" />
<value option="Tuesday" />
<value option="Wednesday" />
<value option="Thursday" />
<value option="Friday" />
<value option="Saturday" />
<value option="Sun" />
<value option="Mon" />
<value option="Tue" />
<value option="Wed" />
<value option="Thu" />
<value option="Fri" />
<value option="Sat" />
</values>
</parameter>
<parameter name="firstdayofweek" required="false" type="Numeric">
<help><![CDATA[
Integer in the range 0-6 specifying the first day of the
week in the calendar, 0 indicates Sunday, 6 indicates Saturday.
Default is: 0
]]></help>
<values default="0">
<value option="0"/>
<value option="1"/>
<value option="2"/>
<value option="3"/>
<value option="4"/>
<value option="5"/>
<value option="6"/>
</values>
</parameter>
<parameter name="monthnames" required="false" type="String">
<help><![CDATA[
A comma-delimited list of the month names that are
displayed at the top of the calendar.
]]></help>
<values >
<value option="January" />
<value option="February" />
<value option="March" />
<value option="April" />
<value option="May" />
<value option="June" />
<value option="July" />
<value option="August" />
<value option="September" />
<value option="October" />
<value option="November" />
<value option="December" />
<value option="Jan" />
<value option="Feb" />
<value option="Mar" />
<value option="Apr" />
<value option="May" />
<value option="Jun" />
<value option="Jul" />
<value option="Aug" />
<value option="Sep" />
<value option="Oct" />
<value option="Nov" />
<value option="Dec" />
</values>
</parameter>
<parameter name="enabled" required="false" type="boolean">
<help><![CDATA[
Flash only: Boolean value specifying whether the control is
enabled. A disabled control appears in light gray. The
inverse of the disabled attribute. Flash only.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="visible" required="false" type="boolean">
<help><![CDATA[
Flash only: Boolean value specifying whether to show the
control. Space that would be occupied by an invisible
control is blank.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="tooltip" required="false" type="String">
<help><![CDATA[
Flash only: Text to display when the mouse pointer hovers
over the control.
]]></help>
<values/>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Applies to most Flash types, HTML image type on
some browsers. The width of the control, in pixels. For
Flash forms, ColdFusion ignores this attribute if you also
specify a size attribute value.
]]></help>
<values/>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
Applies to most Flash types, HTML image type on
some browsers. The height of the control, in pixels. The
displayed height might be less than the specified size.
]]></help>
<values/>
</parameter>
<parameter compatibility="deprecated" name="passthrough"
required="false" type="String">
<help><![CDATA[
This attribute is deprecated.
Passes arbitrary attribute-value pairs to the HTML code
that is generated for the tag. You can use either of the
following formats:
passthrough="title=""myTitle"""
passthrough='title="mytitle"'
]]></help>
<values/>
</parameter>
<parameter name="delimiter" required="false" type="String">
<help><![CDATA[
The delimiter to use to separate entries in a static autosuggest list. This attribute is meaningful only if the autosuggest attribute is a string of delimited values.
]]></help>
</parameter>
<parameter name="maxresultsdisplayed" required="false" type="Numeric">
<help><![CDATA[
The maximum number suggestions to display in the autosuggest list.
Valid only for cfinput type="text".
]]></help>
</parameter>
<parameter name="onbinderror" required="false" type="String">
<help><![CDATA[
The name of a JavaScript function to execute if evaluating a bind expression, including an autosuggest bind expression, results in an error. The function must take two attributes: an HTTP status code and a message.
]]></help>
</parameter>
<parameter name="showautosuggestloadingicon"
required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies whether to display an animated icon when loading an autosuggest value for a text input.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="sourcefortooltip" required="false" type="String">
<help><![CDATA[
The URL of a page to display as a tool tip. The page can include HTML markup to control the format, and the tip can include images.
If you specify this attribute, an animated icon appears with the text "Loading..." while the tip is being loaded.
]]></help>
</parameter>
<parameter name="typeahead" required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies whether the autosuggest feature should automatically complete a user's entry with the first result in the suggestion list.
Valid only for cfinput type="text".
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="matchContains" required="false" type="Boolean">
<help><![CDATA[
true, match returned "contains" the query string. Default is false so that only results that "start with" the query string are returned.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>autosuggest,autosuggestbinddelay,autosuggestminlength,bind,bindattribute,bindonerror,bindonload,class,delimiter,id,mask,maxlength,maxresultsdisplayed,message,onbinderror,onblur,onerror,onvalidate,passthrough,pattern,range,required,showautosuggestloadingicon,sourcefortooltip,tooltip,type,typeahead,validate,value</optional>
</combination>
</possiblecombinations>
</tag>
<tag endtagrequired="false" name="cfinsert" single="true"
xmlstyle="false">
<help><![CDATA[
Inserts records in data sources from data in a CFML form
or form Scope.
]]></help>
<parameter name="datasource" required="true" type="String">
<help><![CDATA[
Data source; contains table.
]]></help>
<values/>
</parameter>
<parameter name="tablename" required="true" type="String">
<help><![CDATA[
Table in which to insert form fields.
ORACLE drivers: must be uppercase.
Sybase driver: case-sensitive. Must be the same case used
when table was created
]]></help>
<values/>
</parameter>
<parameter name="tableowner" required="false" type="String">
<help><![CDATA[
For data sources that support table ownership (such as SQL
Server, Oracle, and Sybase SQL Anywhere), use this field to
specify the owner of the table.
]]></help>
<values/>
</parameter>
<parameter name="tablequalifier" required="false" type="String">
<help><![CDATA[
For data sources that support table qualifiers, use this
field to specify qualifier for table. The purpose of table
qualifiers varies among drivers. For SQL Server and
Oracle, qualifier refers to name of database that contains
table. For Intersolv dBASE driver, qualifier refers to
directory where DBF files are located.
]]></help>
<values/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
Overrides username specified in ODBC setup.
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Overrides password specified in ODBC setup.
]]></help>
<values/>
</parameter>
<parameter name="formfields" required="false" type="String">
<help><![CDATA[
Comma-delimited list of form fields to insert. If not
specified, all fields in the form are included.
If a form field is not matched by a column name in the
database, CFML throws an error.
The database table key field must be present in the form.
It may be hidden.
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="tablename">
<required>tablename</required>
<optional>datasource,formfields,password,tableowner,tablequalifier,username</optional>
</combination>
<combination attributename="tablename">
<required>datasource,tablename</required>
<optional>formfields,password,tableowner,tablequalifier,username</optional>
</combination>
</possiblecombinations>
<parameter name="providerdsn" deprecated="true" required="false" type="String">
<help><![CDATA[
Deprecated
]]></help>
</parameter>
<parameter name="dbtype" deprecated="true" required="false" type="String">
<help><![CDATA[
Deprecated
]]></help>
</parameter>
<parameter name="dbname" deprecated="true" required="false" type="String">
<help><![CDATA[
Deprecated
]]></help>
</parameter>
<parameter name="dbserver" deprecated="true" required="false" type="String">
<help><![CDATA[
Deprecated
]]></help>
</parameter>
<parameter deprecated="true" name="provider"
required="false" type="String">
<help><![CDATA[
Deprecated
]]></help>
</parameter>
</tag>
<!--
cfinvoke
component = "component name or reference"
method = "method name"
returnVariable = "variable name"
argumentCollection = "argument collection"
OR
cfinvoke
method = "method name"
returnVariable = "variable name"
argumentCollection = "argument collection"
OR
cfinvoke
webservice = "URLtoWSDL_location"
method = "operation_name"
username = user name"
password = "password"
timeout = "request timeout in seconds"
proxyServer = "WSDL proxy server URL
proxyPort = "port on proxy server"
proxyUser = "user id for proxy server"
proxyPassword = "password for proxy server"
servicePort = "WSDL port name"
inputParam1 = "value1"
inputParam2 = "value2"
...
returnVariable = "var_name"
OR
cfinvoke
component = "#mystringname for instantiated component#"
method = "method name"
returnVariable = "variable name"
argumentCollection = "argument collection"
OR
cfinvoke
webservice = "#my stringname for instantiated web service#"
timeout = "request timeout in seconds"
proxyServer = "WSDL proxy server url
proxyPort = "numeric port on proxy server"
proxyUser = "string user id for proxy server"
proxyPassword = "string user password for proxy server"
=============================================================
cfinvoke
webservice = "URLtoWSDL_location"
method = "operation_name"
username = user name"
password = "password"
timeout = "request timeout in seconds"
proxyServer = "WSDL proxy server URL
proxyPort = "port on proxy server"
proxyUser = "user id for proxy server"
proxyPassword = "password for proxy server"
returnVariable = "var_name"
component = "component name or reference"
argumentCollection = "argument collection"
-->
<tag allowanyattribute="true" endtagrequired="false"
hybrid="true" name="cfinvoke" single="false"
xmlstyle="false">
<help><![CDATA[
Does either of the following:
* Invokes a component method from within a CFML page or
component.
* Invokes a web service.
Different attribute combonations make some attributes required
at sometimes and not at others.
]]></help>
<return parameter="returnVariable" returnVarType="variablename" type="String"/>
<parameter name="component" required="false" type="String">
<help><![CDATA[
String or component object; a reference to a component, or
component to instantiate.
]]></help>
<values/>
</parameter>
<parameter name="method" required="true" type="String">
<help><![CDATA[
Name of a method. For a web service, the name of an
operation.
]]></help>
<values/>
</parameter>
<parameter name="returnvariable" required="false" type="variableName">
<help><![CDATA[
Name of a variable for the invocation result.
]]></help>
<values/>
</parameter>
<parameter name="argumentcollection" required="false" type="String">
<help><![CDATA[
Name of a structure; associative array of arguments to pass
to the method.
]]></help>
<values/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
Overrides username specified in Administrator > Web Services
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Overrides passowrd specified in Administrator > Web Services
]]></help>
<values/>
</parameter>
<parameter name="webservice" required="false" type="URL">
<help><![CDATA[
The URL of the WSDL file for the web service.
]]></help>
<values/>
</parameter>
<parameter name="timeout" required="false" type="Numeric">
<help><![CDATA[
The timeout for the web service request, in seconds
]]></help>
<values/>
</parameter>
<parameter name="proxyserver" required="false" type="String">
<help><![CDATA[
The proxy server required to access the webservice URL.
]]></help>
<values/>
</parameter>
<parameter name="proxyport" required="false" type="Numeric">
<help><![CDATA[
The port to use on The proxy server.
]]></help>
<values/>
</parameter>
<parameter name="proxyuser" required="false" type="String">
<help><![CDATA[
The user ID to send to the proxy server.
]]></help>
<values/>
</parameter>
<parameter name="proxypassword" required="false" type="String">
<help><![CDATA[
The user's password on the proxy server.
]]></help>
<values/>
</parameter>
<parameter name="serviceport" required="false" type="String">
<help><![CDATA[
The port name for the web service. This value is
case-sensitive and corresponds to the port element's
name attribute under the service element. Specify this
attribute if the web service contains multiple ports.
Default: first port found in the WSDL.
]]></help>
<values/>
</parameter>
<parameter name="refreshwsdl" required="false" type="boolean">
<help><![CDATA[
* yes: reload the WSDL file and regenerate the artifacts used to consume the web service
* no
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="wsdl2javaargs" required="false" type="String">
<help><![CDATA[
A string that contains a space-delimited list of arguments to pass to the WSDL2Java tool that generates Java stubs for the web services.
]]></help>
<values/>
</parameter>
</tag>
<!--
cfinvokeargument
name="argument name"
value="argument value"
omit = "boolean"
-->
<tag endtagrequired="false" name="cfinvokeargument"
single="true"
xmlstyle="false">
<help><![CDATA[
Passes the name and value of a parameter to a component method
or a web service. This tag is used within the cfinvoke tag.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Argument name
]]></help>
<values/>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
Argument value
]]></help>
<values/>
</parameter>
<parameter name="omit" required="false" type="boolean">
<help><![CDATA[
Enables you to omit a parameter when invoking a web service.
It is an error to specify omit="true" if the cfinvoke
webservice attribute is not specified.
- true: omit this parameter when invoking a web service.
- false: do not omit this parameter when invoking a web service.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</tag>
<!--
cflayout
type="border|hbox|tab|vbox"
align="center|justify|left|righ
name="string"
padding="integer"
style="CSS style specification"
tabPosition="top|bottom"
-->
<tag endtagrequired="true" name="cflayout" single="false"
xmlstyle="true">
<help><![CDATA[
Creates a region of its container (such as the browser
window or a cflayoutarea tag) with a specific layout
behavior: a bordered area, a horizontal or vertically
arranged box, or a tabbed navigator.
]]></help>
<parameter name="type" required="true" type="String">
<help><![CDATA[
The type of layout.
]]></help>
<values default="border">
<value option="accordion"/>
<value option="border"/>
<value option="hbox"/>
<value option="tab"/>
<value option="vbox"/>
</values>
</parameter>
<parameter name="align" required="false" type="String">
<help><![CDATA[
Specifies the default alignment of the content of
child layout areas. Each cflayoutarea tag can specify
an alignment attribute to override this value.
]]></help>
<values default="center">
<value option="center"/>
<value option="justify"/>
<value option="left"/>
<value option="right"/>
</values>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
The name of the layout region. Must be unique
on a page.
]]></help>
<values/>
</parameter>
<parameter name="padding" required="false" type="String">
<help><![CDATA[
Applies only to hbox and vbox layouts.
You can use any valid CSS length or percent format,
such as 10, 10% 10px, or 10em, for this attribute.
The padding is included in the child layout area
and takes the style of the layout area.
]]></help>
<values/>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
A CSS style specification that defines layout styles.
]]></help>
<values/>
</parameter>
<parameter name="tabheight" required="false" type="Numeric">
<help><![CDATA[
A CSS style specification that defines layout stApplies only to tab type layouts. Specifies the
height of the content area of all child layout
areas. You can override this setting by
specifying a hight setting in a individual
cflayoutarea tag style attributes.
]]></help>
<values/>
</parameter>
<parameter name="tabposition" required="false" type="Numeric">
<help><![CDATA[
Applies only to tab type layouts. Specifies the
location of the tabs relative to the tab region
contents.
]]></help>
<values default="top">
<value option="top"/>
<value option="bottom"/>
</values>
</parameter>
<possiblecombinations/>
<parameter name="titlecollapse" required="false" type="Boolean">
<help><![CDATA[
Specify whether title bar should act as collapse/expand toggle or not; default=true.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="activeontop" required="false" type="Boolean">
<help><![CDATA[
Specify whether active tab needs to be on top always; default=false.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="fillheight" required="false" type="Boolean">
<help><![CDATA[
True to adjust the active item's height to fill the available space in the container; default=true.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="fitToWindow" required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies whether the border layout should occupy 100% of the width and height of the window
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
]]></help>
Height of the layout in pixels.
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
]]></help>
Width of the layout in pixels.
</parameter>
<parameter name="buttonStyle" required="false" type="String">
<help><![CDATA[
]]></help>
Style for button
</parameter>
</tag>
<!--
cflayoutarea
In a border layout
required
position="bottom|center|left|right|top"
optional
align="left|center|justify|right"
closable="false|true"
collapsible="false|true"
initcollapsed="false|true"
inithide="false|true"
maxSize="number of pixels"
minSize="number of pixels"
name="string"
onBindError = "JavaScript function name"
overflow = "auto|hidden"
size="number of pixels"
source="URL"
splitter="false|true"
style="CSS style specification"
title="string"
In a hbox or vbox layout
optional name="string"
overflow = "auto|hidden|scroll|visble"
size="number of pixels"
source="URL"
style="CSS style specification"
title="string"
In a tab layout
optional
closable="false|true"
disabled="false|true"
inithide="false|true"
name="string"
overflow = "auto|hidden|scroll|visble"
selected="false|true"
source="URL"
style="CSS style specification"
title="string"
-->
<tag endtagrequired="true" name="cflayoutarea" single="false"
xmlstyle="true">
<help><![CDATA[
Defines a region within a cflayout tag body, such as an
individual tab of a tabbed layout. This tag is not used in
Flash forms.
]]></help>
<parameter name="position" required="false" type="String">
<help><![CDATA[
The position...(docs don't explain this one).
]]></help>
<values default="top">
<value option="bottom"/>
<value option="center"/>
<value option="left"/>
<value option="right"/>
<value option="top"/>
</values>
</parameter>
<parameter name="align" required="false" type="String">
<help><![CDATA[
Specifies how to align child controls within the
layout area.
]]></help>
<values default="center">
<value option="center"/>
<value option="justify"/>
<value option="left"/>
<value option="right"/>
</values>
</parameter>
<parameter name="closable" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether the area can close.
Specifying this attribute adds an x icon on the tab or
title bar that a user can click to close the area.
You cannot use this attribute for border layout areas
with a position attribute value of center.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="collapsible" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether the area can collapse.
Specifying this attribute adds a >> or << icon on the
title bar that a user can click to collapse the area.
You cannot use this attribute for border layout areas
with a position attribute value of center.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="disabled" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether the tab is disabled,
that is, whether user can select the tab to display its
contents. Disabled tabs are greyed out. Ignored if the
selected attribute value is true.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="initCollapsed" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether the area is initially
collapsed. You cannot use this attribute for border layout
areas with a position attribute value of center. Ignored
if the collapsible attribute value is false.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="initHide" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether the area is initially
hidden. To show an initially hidden area, use the
ColdFusion.Layout.showArea or ColdFusion.Layout.showTab
function. You cannot use this attribute for border layout
areas with a position attribute value of center.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="maxSize" required="false" type="Numeric">
<help><![CDATA[
For layouts with top or bottom position attributes, the maximum
height of the area, in pixels, that you can set by dragging a
splitter. For layouts with left or right position attributes,
the maximum width of the area. You cannot use this attribute
for border layout areas with a position attribute value of
center.
]]></help>
<values/>
</parameter>
<parameter name="minSize" required="false" type="Numeric">
<help><![CDATA[
For layouts with top or bottom position attributes, the minimum
height of the area, in pixels, that you can set by dragging a
splitter. For layouts with left or right position attributes,
the minimum width of the area., You cannot use this attribute
for border layout areas with a position attribute value of center.
]]></help>
<values/>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
The name of the layout area.
]]></help>
<values/>
</parameter>
<parameter name="onBindError" required="false" type="String">
<help><![CDATA[
The name of a JavaScript function to execute if evaluating a
bind expression results in an error. The function must take
two attributes: an HTTP status code and a message. If you omit
this attribute, and have specified a global error handler
(by using the ColdFusion.setGlobalErrorHandlerfunction ),
it displays the error message; otherwise a default error
pop-up displays.
]]></help>
<values/>
</parameter>
<parameter name="overflow" required="false" type="String">
<help><![CDATA[
Specifies how to display child content whose size would cause
the control to overflow the window boundaries. � In Internet Explorer, layout areas with
the visible setting expand to fit the size of the contents,
rather than having the contents extend beyond the layout area.
]]></help>
<values default="auto">
<value option="auto"/>
<value option="hidden"/>
<value option="scroll"/>
<value option="visible"/>
</values>
</parameter>
<parameter name="selected" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether this tab is initially
selected so that its contents appears in the layout.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="size" required="false" type="Numeric">
<help><![CDATA[
For hbox layouts and border layouts with top or bottom position
attributes, the initial height of the area. For vbox layouts
and border layouts with left or right position attributes, the
initial width of the area. For hbox and vbox layouts, you can
use any valid CSS length or percent format
(such as 10, 10% 10px, or 10em) for this attribute. For border
layouts, this attribute value must be an integer number of
pixels. You cannot use this attribute for border layout areas
with a position attribute value of center. ColdFusion
automatically determines the center size based on the
size of all other layout areas.
]]></help>
<values/>
</parameter>
<parameter name="source" required="false" type="String">
<help><![CDATA[
A URL that returns the layout area contents. ColdFusion uses
standard page path resolution rules. You can use a bind expression
with dependencies in this attribute. If file specified in this
attribute includes tags that use AJAX features, such as cfform,
cfgrid, and cfpod, you must use the cfajaximport tag on the page
that includes the cflayoutarea tag. For more information,
see cfajaximport.
]]></help>
<values/>
</parameter>
<parameter name="splitter" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether the layout area has a divider
between it and the adjacent layoutarea control. Users can drag the
splitter to change the relative sizes of the areas. If this
attribute is set true on a left or right position layout area,
the splitter resizes the area and its adjacent area horizontally.
If this attribute is set true on a top or bottom position
layout area, the splitter resizes the layout vertically.
You cannot use this attribute for border layout areas with
a position attribute value of center
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
A CSS style specification that controls the appearance of the area.
]]></help>
<values/>
</parameter>
<parameter name="title" required="false" type="String">
<help><![CDATA[
For tab layouts, the text to display on the tab. For border
layouts, if you specify this attribute ColdFusion creates
a title bar for the layout area with the specified text as
the title. By default, these layouts do not have a title
bar if they are not closable or collapsible. You cannot
use this attribute for border layout areas with a position
attribute value of center.
]]></help>
<values/>
</parameter>
<parameter name="refreshonactivate" required="false" type="Boolean">
<help><![CDATA[
* true: Refresh the contents of the tab by running the source bind expression whenever the tab display region shows (for example, when the user selects the tab), in addition to when bind events occur.
* false: Refresh the tab display region only when the bind expression is triggered by its bind event.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="titleIcon" required="false" type="String">
<help><![CDATA[
Specifies the location of the icon to display with the title.
]]></help>
<values/>
</parameter>
<parameter name="bindOnLoad" required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies whether to execute
the bind attribute expression when first loading the
form. Ignored if there is no bind attribute.
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<possiblecombinations/>
</tag>
<tag endtagrequired="false" name="cfldap" single="true"
xmlstyle="false">
<help><![CDATA[
Provides an interface to a Lightweight Directory Access Protocol
(LDAP) directory server, such as the Netscape Directory Server.
]]></help>
<parameter name="server" required="true" type="String">
<help><![CDATA[
Host name or IP address of LDAP server.
]]></help>
<values/>
</parameter>
<parameter name="port" required="false" type="Numeric">
<help><![CDATA[
Port of the LDAP server (default 389).
]]></help>
<values default="389"/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
The User ID. Required if secure = "CFSSL_BASIC"
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Password that corresponds to user name.
If secure = "CFSSL_BASIC", V2 encrypts the password before
transmission.
]]></help>
<values/>
</parameter>
<parameter isswitchattribute="true" name="action"
required="false" type="String">
<help><![CDATA[
* query: returns LDAP entry information only. Requires name,
start, and attributes attributes.
* add: adds LDAP entries to LDAP server. Requires attributes
attribute.
* modify: modifies LDAP entries, except distinguished name dn
attribute, on LDAP server. Requires dn. See modifyType attribute.
* modifyDN: modifies distinguished name attribute for LDAP
entries on LDAP server. Requires dn.
* delete: deletes LDAP entries on an LDAP server. Requires dn.
]]></help>
<values default="query">
<value option="query"/>
<value option="add"/>
<value option="modify"/>
<value option="modifyDN"/>
<value option="delete"/>
</values>
</parameter>
<parameter name="name" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
Required if action = "Query"
Name of LDAP query. The tag validates the value.
]]></help>
<values/>
</parameter>
<parameter name="timeout" required="false" type="Numeric">
<help><![CDATA[
Maximum length of time, in seconds, to wait for LDAP processing.
Default 60000
]]></help>
<values default="60000"/>
</parameter>
<parameter name="maxrows" required="false" type="Numeric">
<help><![CDATA[
Maximum number of entries for LDAP queries.
]]></help>
<values/>
</parameter>
<parameter name="start" required="false" type="Numeric">
<help><![CDATA[
Required if action = "Query"
Distinguished name of entry to be used to start a search.
]]></help>
<values/>
</parameter>
<parameter name="scope" required="false" type="String">
<help><![CDATA[
Scope of search, from entry specified in start attribute for
action = "Query".
* oneLevel: entries one level below entry.
* base: only the entry.
* subtree: entry and all levels below it.
]]></help>
<values default="onelevel">
<value option="onelevel"/>
<value option="base"/>
<value option="subtree"/>
</values>
</parameter>
<parameter name="attributes" required="false" type="String">
<help><![CDATA[
Required if action = "Query", "Add", "ModifyDN", or "Modify"
For queries: comma-delimited list of attributes to return. For
queries, to get all attributes, specify "*".
If action = "add" or "modify", you can specify a list of update
columns. Separate attributes with a semicolon.
If action = "ModifyDN", CFML passes attributes to the
LDAP server without syntax checking.
]]></help>
<values/>
</parameter>
<parameter name="returnasbinary" required="false" type="String">
<help><![CDATA[
A comma-delimited list of columns that are to
be returned as binary values.
]]></help>
<values/>
</parameter>
<parameter name="filter" required="false" type="String">
<help><![CDATA[
Search criteria for action = "Query".
List attributes in the form:
"(attribute operator value)" Example: "(sn = Smith)"
]]></help>
<values/>
</parameter>
<parameter name="sort" required="false" type="String">
<help><![CDATA[
Attribute(s) by which to sort query results. Use a comma
delimiter.
]]></help>
<values/>
</parameter>
<parameter name="sortcontrol" required="false" type="String">
<help><![CDATA[
Default asc
* nocase: case-insensitive sort
* asc: ascending (a to z) case-sensitive sort
* desc: descending (z to a) case-sensitive sort
You can enter a combination of sort types; for example,
sortControl = "nocase, asc".
]]></help>
<values default="asc">
<value option="nocase"/>
<value option="asc"/>
<value option="desc"/>
<value option="nocase, desc"/>
<value option="nocase, asc"/>
</values>
</parameter>
<parameter name="dn" required="false" type="String">
<help><![CDATA[
Distinguished name, for update action. Example:
"cn = Bob Jensen, o = Ace Industry, c = US"
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="add"/>
<selectedValue attributeName="action"
required="true" value="modify"/>
<selectedValue attributeName="action"
required="true" value="modifyDN"/>
<selectedValue attributeName="action"
required="true" value="delete"/>
</triggers>
</parameter>
<parameter name="startrow" required="false" type="Numeric">
<help><![CDATA[
Used with action = "query". First row of LDAP query to insert
into a CFML query.
]]></help>
<values/>
</parameter>
<parameter name="modifytype" required="false" type="String">
<help><![CDATA[
Default replace
How to process an attribute in a multi-value list.
* add: appends it to any attributes
* delete: deletes it from the set of attributes
* replace: replaces it with specified attributes
You cannot add an attribute that is already present or that is
empty.
]]></help>
<values default="replace">
<value option="add"/>
<value option="delete"/>
<value option="replace"/>
</values>
</parameter>
<parameter name="rebind" required="false" type="boolean">
<help><![CDATA[
* Yes: attempt to rebind referral callback and reissue query by
referred address using original credentials.
* No: referred connections are anonymous
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="referral" required="false" type="Numeric">
<help><![CDATA[
Number of hops allowed in a referral. A value of 0 disables
referred addresses for LDAP; no data is returned.
]]></help>
<values/>
</parameter>
<parameter name="secure" required="false" type="String">
<help><![CDATA[
Security to employ, and required information. One option:
* CFSSL_BASIC
"CFSSL_BASIC" provides V2 SSL encryption
and server authentication.
]]></help>
<values>
<value option="CFSSL_BASIC"/>
</values>
</parameter>
<parameter name="separator" required="false" type="String">
<help><![CDATA[
Default , (a comma)
Delimiter to separate attribute values of multi-value
attributes. Used by query, add, and modify actions, and by
cfldap to output multi-value attributes.
For example, if $ (dollar sign), the attributes attribute could
be "objectclass = top$person", where the first value of
objectclass is top, and the second value is person. This avoids
confusion if values include commas.
]]></help>
<values default=",">
<value option=","/>
<value option=";"/>
<value option="|"/>
<value option=":"/>
</values>
</parameter>
<parameter name="delimiter" required="false" type="String">
<help><![CDATA[
Separator between attribute name-value pairs. Use this
attribute if:
* the attributes attribute specifies more than one item, or
* an attribute contains the default delimiter (semicolon). For
example: mgrpmsgrejecttext;lang-en
Used by query, add, and modify actions, and by cfldap to output
multi-value attributes.
For example, if $ (dollar sign), you could specify
"cn = Double Tree Inn$street = 1111 Elm; Suite 100 where the
semicolon is part of the street value.
]]></help>
<values default=";">
<value option=","/>
<value option=";"/>
<value option="|"/>
<value option=":"/>
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="modify">
<required>attributes,dn</required>
<optional>delimiter,modifytype,password,port,rebind,referral,secure,separator,server,timeout,username</optional>
</combination>
<combination switchvalue="add">
<required>attributes,dn</required>
<optional>delimiter,password,port,rebind,referral,secure,separator,server,timeout,username</optional>
</combination>
<combination switchvalue="query">
<required>attributes,name,start</required>
<optional>delimiter,filter,maxrows,password,port,rebind,referral,returnasbinary,scope,secure,separator,server,sort,sortcontrol,startrow,timeout,username</optional>
</combination>
<combination switchvalue="delete">
<required>dn</required>
<optional>attributes,delimiter,password,port,rebind,referral,secure,server,timeout,username</optional>
</combination>
<combination switchvalue="modifydn">
<required>attributes,dn</required>
<optional>delimiter,password,port,rebind,referral,secure,server,timeout,username</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cflocation
url = "URL"
addToken = "boolean"
-->
<tag endtagrequired="false" name="cflocation" single="true"
xmlstyle="false">
<help><![CDATA[
Stops execution of the current page and opens a CFML page or HTML file.
]]></help>
<parameter name="url" required="true" type="String">
<help><![CDATA[
URL of HTML file or CFML page to open.
]]></help>
</parameter>
<parameter name="addtoken" required="false" type="boolean">
<help><![CDATA[
clientManagement must be enabled (see cfapplication).
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="statuscode" required="false" type="Numeric">
<help><![CDATA[
The HTTP status code
]]></help>
</parameter>
<possiblecombinations>
<combination attributename="url">
<required>url</required>
<optional>addtoken,statuscode</optional>
</combination>
</possiblecombinations>
</tag>
<tag endtagrequired="true" name="cflock" single="false"
xmlstyle="true">
<help><![CDATA[
Ensures the integrity of shared data. Instantiates the
following kinds of locks:
* Exclusive allows single-thread access to the CFML constructs
* Read-only allows multiple requests to access CFML constructs
]]></help>
<parameter name="timeout" required="true" type="Numeric">
<help><![CDATA[
Maximum length of time, in seconds, to wait to obtain a
lock. If lock is obtained, tag execution continues.
Otherwise, behavior depends on throwOnTimeout attribute
value.
]]></help>
<values/>
</parameter>
<parameter name="scope" required="false" type="String">
<help><![CDATA[
Lock scope. Mutually exclusive with the name attribute.
Lock name. Only one request in the specified scope can
execute the code within this tag (or within any other
cflock tag with the same lock scope scope) at a time.
]]></help>
<values>
<value option="Application"/>
<value option="request"/>
<value option="Server"/>
<value option="Session"/>
</values>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
Lock name. Mutually exclusive with the scope attribute.
Only one request can execute the code within a cflock tag
with a given name at a time. Cannot be an empty string.
]]></help>
<values/>
</parameter>
<parameter name="throwontimeout" required="false" type="boolean">
<help><![CDATA[
How timeout conditions are handled.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
readOnly: lets more than one request read shared data.
exclusive: lets one request read or write shared data.
]]></help>
<values default="exclusive">
<value option="readonly"/>
<value option="exclusive"/>
</values>
</parameter>
<possiblecombinations>
<combination attributename="timeout">
<required>timeout</required>
<optional>count,name,throwontimeout,type</optional>
</combination>
<combination attributename="timeout">
<required>scope,timeout</required>
<optional>throwontimeout,type</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cflog
text = "text"
log = "log type"
file = "filename"
type = "message type"
application = "application name yes or no"
-->
<tag endtagrequired="false" name="cflog" single="true"
xmlstyle="false">
<help><![CDATA[
Writes a message to a log file.
]]></help>
<parameter name="text" required="true" type="String">
<help><![CDATA[
Message text to log.
]]></help>
<values/>
</parameter>
<parameter name="log" required="false" type="String">
<help><![CDATA[
If you omit the file attribute, writes messages to standard
log file. Ignored, if you specify file attribute.
Application: writes to Application.log, normally used for
application-specific messages.
Scheduler: writes to Scheduler.log, normally used to log
the execution of scheduled tasks.
]]></help>
<values>
<value option="Application"/>
<value option="Scheduler"/>
</values>
</parameter>
<parameter name="file" required="false" type="String">
<help><![CDATA[
Message file. Specify only the main part of the filename.
For example, to log to the Testing.log file, specify
"Testing".
The file must be located in the default log directory. You
cannot specify a directory path. If the file does not
exist, it is created automatically, with the suffix .log.
]]></help>
<values/>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
Type (severity) of the message
]]></help>
<values>
<value option="information"/>
<value option="warning"/>
<value option="error"/>
<value option="fatal"/>
</values>
</parameter>
<parameter name="application" required="false" type="boolean">
<help><![CDATA[
log application name, if it is specified in a cfapplication
tag.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations/>
</tag>
<!--
cflogin
idletimeout = "value"
applicationToken = "token"
cookieDomain = "domain"
...
/cflogin
-->
<tag endtagrequired="true" name="cflogin" single="false"
xmlstyle="false">
<help><![CDATA[
A container for user login and authentication code. CFML
runs the code in this tag if a user is not already logged in.
You put code in the tag that authenticates the user and
identifies the user with a set of roles. Used with cfloginuser
tag.
]]></help>
<parameter name="idletimeout" required="false" type="Numeric">
<help><![CDATA[
Time interval with no keyboard activity after which
CFML logs the user off. Seconds.
]]></help>
<values/>
</parameter>
<parameter name="applicationtoken" required="false" type="String">
<help><![CDATA[
Unique application identifier. Limits the login validity to
one application, as specified by the cfapplication tag.
]]></help>
<values/>
</parameter>
<parameter name="cookiedomain" required="false" type="String">
<help><![CDATA[
Domain of the cookie that is used to mark a user as logged
in. Use this attribute to enable a user login cookie to
work with multiple clustered servers in the same domain.
]]></help>
<values/>
</parameter>
</tag>
<!--
cfloginuser
name = "name"
password = "password-string"
roles = "roles"
-->
<tag endtagrequired="false" name="cfloginuser" single="true"
xmlstyle="false">
<help><![CDATA[
Identifies an authenticated user to CFML. Specifies the
user ID and roles. Used within a cflogin tag.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
A username.
]]></help>
<values/>
</parameter>
<parameter name="password" required="true" type="String">
<help><![CDATA[
A user password.
]]></help>
<values/>
</parameter>
<parameter name="roles" required="true" type="String">
<help><![CDATA[
A comma-delimited list of role identifiers.
CFML processes spaces in a list element as part of
the element.
]]></help>
<values/>
</parameter>
</tag>
<!--
cflogout
-->
<tag endtagrequired="false" name="cflogout" single="true"
xmlstyle="false">
<help><![CDATA[
Logs the current user out. Removes knowledge of the user ID,
password, and roles from the server. If you do not use this
tag, the user is automatically logged out when the session
ends.
]]></help>
</tag>
<tag endtagrequired="true" canHaveAttributeCollection="false" name="cfloop" single="false"
xmlstyle="true">
<help><![CDATA[
Different items are required based on loop type. Items listed
as required may not be depending on your loop type.
Loop forms:
[query] [condition] [index + from + to ] [index + list]
[collection + item ]
]]></help>
<parameter name="index" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
Index value. CFML sets it to from value and
increments or decrements by step value, until it equals to
value.
]]></help>
<values/>
</parameter>
<parameter name="to" required="false" type="Numeric">
<help><![CDATA[
Beginning value of index.
]]></help>
<values/>
</parameter>
<parameter name="from" required="false" type="Numeric">
<help><![CDATA[
Ending value of index.
]]></help>
<values/>
</parameter>
<parameter name="step" required="false" type="Numeric">
<help><![CDATA[
Ending value of index.
]]></help>
<values/>
</parameter>
<parameter name="condition" required="false" type="String">
<help><![CDATA[
Condition that controls the loop.
]]></help>
<values/>
</parameter>
<parameter name="query" required="false" type="query">
<help><![CDATA[
Query that controls the loop.
]]></help>
<values/>
</parameter>
<parameter name="startrow" required="false" type="Numeric">
<help><![CDATA[
First row of query that is included in the loop.
]]></help>
<values/>
</parameter>
<parameter name="endrow" required="false" type="Numeric">
<help><![CDATA[
Last row of query that is included in the loop.
]]></help>
<values/>
</parameter>
<parameter name="list" required="false" type="String">
<help><![CDATA[
A list, variable, or filename; contains a list
]]></help>
<values/>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
Character(s) that separates items in list
]]></help>
<values default=",">
<value option=","/>
<value option=";"/>
<value option="|"/>
<value option=":"/>
</values>
</parameter>
<parameter name="collection" required="false" type="Object">
<help><![CDATA[
The collection attribute is used with the item attribute.
often to loop over a structure
]]></help>
<values/>
</parameter>
<parameter name="item" required="false" type="String">
<help><![CDATA[
The item attribute is used with the collection attribute.
often to loop over a structure
]]></help>
<values/>
</parameter>
<parameter name="array" required="false" type="AnyValue">
<help><![CDATA[
An array.
]]></help>
</parameter>
<parameter name="characters" required="false" type="Numeric">
<help><![CDATA[
The number of characters to read during each iteration of the loop from the file specified in the file attribute.
If the value of the characters attribute is more than the number of characters in the file,
ColdFusion uses the number of characters in the file.
]]></help>
</parameter>
<parameter name="file" required="false" type="String">
<help><![CDATA[
The absolute path and filename of the text file to read, one line at a time.
This is helpful when reading large text files, because you can reuse the value of the index variable,
which contains the current line of the file.
When the loop completes, ColdFusion closes the file.
]]></help>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfmail
to = "recipient"
from = "sender"
cc = "copy_to"
bcc = "blind_copy_to"
subject = "msg_subject"
replyto = "reply_to_addr"
failto = "fail_message_addr"
username = "user name"
password = "password"
wraptext = "column number"
charset = "character encoding"
type = "msg_type"
mimeattach = "path"
query = "query_name"
group = "query_column"
groupcasesensitive = "boolean"
startrow = "query_row"
maxrows = "max_msgs"
server = "serverspecs"
port = "port_id"
mailerid = "headerid"
timeout = "seconds"
spoolenable = "boolean"
[(Optional) Mail message body and/or cfhttpparam tags]
/cfmail
-->
<tag endtagrequired="true" name="cfmail" single="false"
xmlstyle="true">
<help><![CDATA[
Sends an e-mail message that optionally contains query output,
using an SMTP server.
]]></help>
<parameter name="to" required="true" type="String">
<help><![CDATA[
Message recipient e-mail addresses.
]]></help>
<values/>
</parameter>
<parameter name="from" required="true" type="String">
<help><![CDATA[
E-mail message sender:
]]></help>
<values/>
</parameter>
<parameter name="cc" required="false" type="String">
<help><![CDATA[
Address(es) to which to copy the message
]]></help>
<values/>
</parameter>
<parameter name="bcc" required="false" type="String">
<help><![CDATA[
Address(es) to which to copy the message, without listing
them in the message header.
]]></help>
<values/>
</parameter>
<parameter name="subject" required="true" type="String">
<help><![CDATA[
Message subject. Can be dynamically generated.
]]></help>
<values/>
</parameter>
<parameter name="replyto" required="false" type="String">
<help><![CDATA[
Address(es) to which the recipient is directed to send
replies.
]]></help>
<values/>
</parameter>
<parameter name="failto" required="false" type="String">
<help><![CDATA[
Address to which mailing systems should send delivery
failure notifications. Sets the mail envelope reverse-path
value.
]]></help>
<values/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
A user name to send to SMTP servers that require
authentication. Requires a password attribute
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
A password to send to SMTP servers that require
authentication. Requires a username attribute.
]]></help>
<values/>
</parameter>
<parameter name="wraptext" required="false" type="Numeric">
<help><![CDATA[
Specifies the maximum line length, in characters of the
mail text. If a line has more than the specified number of
characters, replaces the last white space character, such
as a tab or space, preceding the specified position with
a line break. If there are no white space characters,
inserts a line break at the specified position. A common
value for this attribute is 72.
]]></help>
<values/>
</parameter>
<parameter name="charset" required="false" type="String">
<help><![CDATA[
The character encoding in which the part text is encoded.
For more information on character encodings, see:
www.w3.org/International/O-charset.html.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
The MIME media type of the part. Can be a can be valid MIME
media type
]]></help>
<values default="text/plain">
<value option="plain"/>
<value option="html"/>
<value option="text"/>
<value option="text/html"/>
<value option="text/plain"/>
</values>
</parameter>
<parameter name="mimeattach" required="false" type="String">
<help><![CDATA[
Path of file to attach to message. Attached file is
MIME-encoded. CFML attempts to determine the MIME
type of the file; use the cfmailparam tag to send an
attachement and specify the MIME type.
]]></help>
<values/>
</parameter>
<parameter name="query" required="false" type="query">
<help><![CDATA[
Name of cfquery from which to draw data for message(s).
Use this attribute to send more than one message, or to
send query results within a message.
]]></help>
<values/>
</parameter>
<parameter name="group" required="false" type="String">
<help><![CDATA[
Query column to use when you group sets of records to send
as a message. For example, to send a set of billing
statements to a customer, group on "Customer_ID."
Case-sensitive. Eliminates adjacent duplicates when data is
sorted by the specified field.
]]></help>
<values/>
</parameter>
<parameter name="groupcasesensitive" required="false" type="boolean">
<help><![CDATA[
Whether to consider case when using the group attribute. To
group on case-sensitive records, set this attribute to Yes.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="startrow" required="false" type="Numeric">
<help><![CDATA[
Row in a query to start from.
]]></help>
<values default="1"/>
</parameter>
<parameter name="maxrows" required="false" type="Numeric">
<help><![CDATA[
Maximum number of messages to send when looping over a
query.
]]></help>
<values/>
</parameter>
<parameter name="server" required="false" type="String">
<help><![CDATA[
SMTP server address, or (Enterprise edition only) a
comma-delimited list of server addresses, to use for
sending messages. At least one server must be specified
here or in the CFML MX Administrator. A value here
overrides the Administrator. A value that includes a port
specification overrides the port attribute. See the Usage
section for details.
]]></help>
<values/>
</parameter>
<parameter name="port" required="false" type="Numeric">
<help><![CDATA[
TCP/IP port on which SMTP server listens for requests
(normally 25). A value here overrides the Administrator.
]]></help>
<values/>
</parameter>
<parameter name="mailerid" required="false" type="String">
<help><![CDATA[
Mailer ID to be passed in X-Mailer SMTP header, which
identifies the mailer application.
]]></help>
<values/>
</parameter>
<parameter name="timeout" required="false" type="Numeric">
<help><![CDATA[
Number of seconds to wait before timing out connection to
SMTP server. A value here overrides the Administrator.
]]></help>
<values/>
</parameter>
<parameter name="spoolenable" required="false" type="boolean">
<help><![CDATA[
Specifies whether to spool mail or always send it
Immediately. Overrides the CFML MX Administrator
Spool mail messages to disk for delivery setting.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="debug" required="false" type="boolean">
<help><![CDATA[
* Yes: sends debugging output to standard output. By
default, if the console window is unavailable, ColdFusion
sends output to cf_root\runtime\logs\coldfusion-out.log on
server configurations. On J2EE configurations, with JRun,
the default location is jrun_home/logs/servername-out.log.
* No: does not generate debugging output.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="priority" required="false" type="String">
<help><![CDATA[
The message priority level. Can be one of the following values:
* An integer in the range 1-5; 1 represents the highest priority.
* One of the following string values, which correspond to the numeric values: highest or urgent, high, normal, low, and lowest or non-urgent.
]]></help>
<values default="normal">
<value option="highest"/>
<value option="urgent"/>
<value option="normal"/>
<value option="low"/>
<value option="lowest"/>
</values>
</parameter>
<parameter name="usessl" required="false" type="Boolean">
<help><![CDATA[
Whether to use Secure Sockets Layer.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="usetls" required="false" type="Boolean">
<help><![CDATA[
Whether to use Transport Level Security.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="remove" required="false" type="boolean">
<help><![CDATA[
Tells ColdFusion to remove any attachments after successful mail delivery.
]]></help>
<values/>
</parameter>
<parameter name="keystore" required="false" type="String">
<help><![CDATA[
Keystore containing the private key and certificate. The supported type is JKS (java key store) and pkcs12
]]></help>
</parameter>
<parameter name="keypassword" required="false" type="String">
<help><![CDATA[
Password with which the private key is stored. If it is not specified, keystorepassword will be used as keypassword as well.
]]></help>
</parameter>
<parameter name="sign" required="false" type="Boolean">
<help><![CDATA[
Mail will be signed when set to true
]]></help>
</parameter>
<parameter name="keyalias" required="false" type="String">
<help><![CDATA[
Alias of the key with which the certificate and private key is stored in keystore. If it is not specified then the first entry in the keystore will be picked up.
]]></help>
</parameter>
<parameter name="keystorepassword" required="false" type="String">
<help><![CDATA[
Password of the keystore
]]></help>
</parameter>
<possiblecombinations>
<combination attributename="from">
<required>from,query,subject,to</required>
<optional>bcc,cc,charset,debug,failto,mailerid,maxrows,mimeattach,password,port,priority,remove,replyto,server,spoolenable,startrow,timeout,type,username,usessl,usetls,wraptext</optional>
</combination>
<combination attributename="from">
<required>from,subject,to</required>
<optional>bcc,cc,charset,debug,failto,mailerid,mimeattach,password,port,priority,remove,replyto,server,spoolenable,timeout,type,username,usessl,usetls,wraptext</optional>
</combination>
<combination attributename="from">
<required>from,group,subject,to</required>
<optional>bcc,cc,charset,debug,failto,groupcasesensitive,mailerid,maxrows,mimeattach,password,port,priority,remove,replyto,server,spoolenable,timeout,type,username,usessl,usetls,wraptext</optional>
</combination>
<combination attributename="from">
<required>from,group,query,subject,to</required>
<optional>bcc,cc,charset,debug,failto,groupcasesensitive,mailerid,maxrows,mimeattach,password,port,priority,remove,replyto,server,spoolenable,startrow,timeout,type,username,usessl,usetls,wraptext</optional>
</combination>
<combination attributename="subject">
<required>from,query,subject,to</required>
<optional>bcc,cc,charset,debug,failto,mailerid,maxrows,mimeattach,password,port,priority,remove,replyto,server,spoolenable,startrow,timeout,type,username,usessl,usetls,wraptext</optional>
</combination>
<combination attributename="subject">
<required>from,subject,to</required>
<optional>bcc,cc,charset,debug,failto,mailerid,mimeattach,password,port,priority,remove,replyto,server,spoolenable,timeout,type,username,usessl,usetls,wraptext</optional>
</combination>
<combination attributename="subject">
<required>from,group,subject,to</required>
<optional>bcc,cc,charset,debug,failto,groupcasesensitive,mailerid,maxrows,mimeattach,password,port,priority,remove,replyto,server,spoolenable,timeout,type,username,usessl,usetls,wraptext</optional>
</combination>
<combination attributename="subject">
<required>from,group,query,subject,to</required>
<optional>bcc,cc,charset,debug,failto,groupcasesensitive,mailerid,maxrows,mimeattach,password,port,priority,remove,replyto,server,spoolenable,startrow,timeout,type,username,usessl,usetls,wraptext</optional>
</combination>
<combination attributename="to">
<required>from,query,subject,to</required>
<optional>bcc,cc,charset,debug,failto,mailerid,maxrows,mimeattach,password,port,priority,remove,replyto,server,spoolenable,startrow,timeout,type,username,usessl,usetls,wraptext</optional>
</combination>
<combination attributename="to">
<required>from,subject,to</required>
<optional>bcc,cc,charset,debug,failto,mailerid,mimeattach,password,port,priority,remove,replyto,server,spoolenable,timeout,type,username,usessl,usetls,wraptext</optional>
</combination>
<combination attributename="to">
<required>from,group,subject,to</required>
<optional>bcc,cc,charset,debug,failto,groupcasesensitive,mailerid,maxrows,mimeattach,password,port,priority,remove,replyto,server,spoolenable,timeout,type,username,usessl,usetls,wraptext</optional>
</combination>
<combination attributename="to">
<required>from,group,query,subject,to</required>
<optional>bcc,cc,charset,debug,failto,groupcasesensitive,mailerid,maxrows,mimeattach,password,port,priority,remove,replyto,server,spoolenable,startrow,timeout,type,username,usessl,usetls,wraptext</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfmailparam
file = "file-name"
type ="media type"
contentID = "content ID"
disposition = "disposition type"
or
cfmailparam
name = "header-name"
value = "header-value"
-->
<tag endtagrequired="false" name="cfmailparam" single="true"
xmlstyle="false">
<help><![CDATA[
Attaches a file or adds a header to an e-mail message. Can only
be used in the cfmail tag. You can use more than one
cfmailparam tag within a cfmail tag.
]]></help>
<parameter name="file" required="false" type="String">
<help><![CDATA[
Attaches file to a message. Mutually exclusive with name
attribute. The file is MIME encoded before sending.
]]></help>
<values/>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
The MIME media type of the part. Can be a can be valid MIME
media type
]]></help>
<values>
<value option="text/plain"/>
<value option="text/html"/>
<value option="html"/>
<value option="plain"/>
<value option="text"/>
</values>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
Name of header. Case-insensitive. Mutually exclusive with
file attribute.
The values listed are from rfc2822
]]></help>
<values>
<value option="Message-Context"/>
<value option="Apparently-To"/>
<value option="Approved-By"/>
<value option="Fax"/>
<value option="Telefax"/>
<value option="For-Approval"/>
<value option="For-Comment"/>
<value option="For-Handling"/>
<value option="Mail-System-Version"/>
<value option="Mailer"/>
<value option="Originating-Client"/>
<value option="X-Mailer "/>
<value option="X-Newsreader"/>
<value option="X-MimeOLE"/>
<value option="User-Agent"/>
<value option="Originator-Info"/>
<value option="Phone"/>
<value option="X-Envelope-From"/>
<value option="Envelope-To"/>
<value option="X-Envelope-To"/>
<value option="X-Face"/>
<value option="X-RCPT-TO"/>
<value option="X-Sender"/>
<value option="X-X-Sender"/>
<value option="Posted-To"/>
<value option="X-Admin"/>
<value option="Errors-To"/>
<value option="Return-Receipt-To"/>
<value option="Read-Receipt-To"/>
<value option="X-Confirm-reading-to"/>
<value option="Return-Receipt-Requested"/>
<value option="Register-Mail-Reply-Requested-By"/>
<value option="Abuse-Reports-To"/>
<value option="X-Complaints-To"/>
<value option="X-Report-Abuse-To"/>
<value option="Content-Alias"/>
<value option="Delivered-To"/>
<value option="X-Loop"/>
<value option="Translated-By"/>
<value option="Translation-Of"/>
<value option="X-UIDL"/>
<value option="X-URI"/>
<value option="X-URL"/>
<value option="X-IMAP"/>
<value option="X-OriginalArrivalTime"/>
<value option="Precedence"/>
<value option="X-MSMail-Priority"/>
<value option="X-Priority"/>
<value option="Content-Length"/>
<value option="Content-Conversion"/>
<value option="Content-Class"/>
<value option="Content-SGML-Entity"/>
<value option="X-MIME-Autoconverted"/>
<value option="List-Digest"/>
<value option="Mailing-List"/>
<value option="X-Mailing-List"/>
<value option="List-Software"/>
<value option="List-URL"/>
<value option="X-Listserver"/>
<value option="X-List-Host"/>
<value option="Fcc"/>
<value option="Speech-Act"/>
<value option="Status"/>
<value option="X-No-Archive"/>
</values>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
Value of the header.
]]></help>
<values/>
</parameter>
<parameter name="contentID" required="false" type="String">
<help><![CDATA[
The Identifier for the attached file. This ID should
be globally unique and is used to identify the file in
an IMG or other tag in the mail body that references
the file content.
]]></help>
<values/>
</parameter>
<parameter name="disposition" required="false" type="String">
<help><![CDATA[
How the attached file is to be handled. Can be one
of the following:
- attachment: present the file as an attachment
- inline: display the file contents in the message
]]></help>
<values default="attachment">
<value option="attachment"/>
<value option="inline"/>
</values>
</parameter>
<parameter name="content" required="false" type="String">
<help><![CDATA[
Lets you send the contents of a
ColdFusion variable as an attachment
]]></help>
<values/>
</parameter>
<parameter name="remove" required="false" type="boolean">
<help><![CDATA[
Tells ColdFusion to remove any attachments after successful mail delivery.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfmailpart
type="mime type"
charset="character encoding"
wraptext="number"
[Mail part contents]
/cfmailpart
-->
<tag endtagrequired="true" name="cfmailpart" single="false"
xmlstyle="false">
<help><![CDATA[
Specifies one part of a multipart e-mail message. Can only be
used in the cfmail tag. You can use more than one cfmailpart
tag within a cfmail tag.
]]></help>
<parameter name="type" required="true" type="String">
<help><![CDATA[
The MIME media type of the part. Can be a can be valid MIME
media type
]]></help>
<values>
<value option="text/plain"/>
<value option="text/html"/>
</values>
</parameter>
<parameter name="wraptext" required="false" type="Numeric">
<help><![CDATA[
Specifies the maximum line length, in characters of the
mail text. If a line has more than the specified number of
characters, replaces the last white space character, such
as a tab or space, preceding the specified position with a
line break. If there are no white space characters,
inserts a line break at the specified position. A common
value for this attribute is 72.
]]></help>
<values/>
</parameter>
<parameter name="charset" required="false" type="String">
<help><![CDATA[
The character encoding in which the part text is encoded.
For more information on character encodings, see:
www.w3.org/International/O-charset.html.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
</parameter>
</tag>
<!--
cfmodule
template = "path"
name = "tag_name"
attributeCollection = "collection_structure"
attribute_name1 = "valuea"
attribute_name2 = "valueb" ...
-->
<tag allowanyattribute="true" canHaveAttributeCollection="false" endtagrequired="false"
hybrid="true" name="cfmodule" single="false"
xmlstyle="false">
<help><![CDATA[
Invokes a custom tag for use in CFML application pages.
This tag processes custom tag name conflicts.
]]></help>
<parameter name="template" required="false" type="String">
<help><![CDATA[
Mutually exclusive with the name attribute. A path to the
page that implements the tag.
Relative path: expanded from the current page
Absolute path: expanded using CFML mapping
A physical path is not valid.
]]></help>
<values/>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
Mutually exclusive with the template attribute. A custom
tag name, in the form "Name.Name.Name..." Identifies
subdirectory, under the CFML tag root directory,
that contains custom tag page. For example (Windows format):
<cfmodule name = "superduper.Forums40.GetUserOptions">
This identifies the page GetUserOptions.cfm in the
directory CustomTags\superduper\Forums40 under the
CFML root directory.
]]></help>
<values/>
</parameter>
<parameter name="attributecollection" required="false" type="Struct">
<help><![CDATA[
A collection of key-value pairs that represent
attribute names and values. You can specify multiple
key-value pairs. You can specify this attribute only
once.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfntauthenticate
username="username"
password="password"
domain="nt_domain"
result="result variable"
listGroups = "boolean"
throwOnError = "boolean"
-->
<tag endtagrequired="false" name="cfntauthenticate"
single="true"
xmlstyle="false">
<help><![CDATA[
Authenticates a user name and password against the
NT domain on which ColdFusion server is running,
and optionally retrieves the user's groups.
]]></help>
<return parameter="result" type="variablename"/>
<parameter name="username" required="true" type="String">
<help><![CDATA[
User's login name.
]]></help>
<values/>
</parameter>
<parameter name="password" required="true" type="String">
<help><![CDATA[
User's login name.
]]></help>
<values/>
</parameter>
<parameter name="domain" required="true" type="String">
<help><![CDATA[
Domain against which to authenticate the user. The
ColdFusion J2EE server must be running on this domain.
]]></help>
<values/>
</parameter>
<parameter name="result" required="false" returnVarType="variablename" type="variableName">
<help><![CDATA[
Name of the variable in which to return the results.
Default: cfntauthenticate
]]></help>
<values default="cfntauthenticate"/>
</parameter>
<parameter name="listgroups" required="false" type="boolean">
<help><![CDATA[
Boolean value specifying whether to Include a
comma-delimited list of the user's groups in the
result structure.
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="throwonerror" required="false" type="boolean">
<help><![CDATA[
Boolean value specifying whether to throw an
exception if the validation fails. If this attribute is true,
ColdFusion throws an error if the user name or password is
invalid; the application must handle such errors in a
try/catch block or ColdFusion error handler page.
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations>
<combination attributename="domain">
<required>domain,password,username</required>
<optional>listgroups,result,throwonerror</optional>
</combination>
<combination attributename="password">
<required>domain,password,username</required>
<optional>listgroups,result,throwonerror</optional>
</combination>
<combination attributename="username">
<required>domain,password,username</required>
<optional>listgroups,result,throwonerror</optional>
</combination>
</possiblecombinations>
</tag>
<tag endtagrequired="false" name="cfobject" single="true"
xmlstyle="false">
<help><![CDATA[
Creates a CFML object, of a specified type.
The tag syntax depends on the object type. Some types use the
type attribute; others do not.
]]></help>
<return parameter="name" type="variablename"/>
<parameter isswitchattribute="true" name="type"
required="false" type="String">
<help><![CDATA[
The object type. You can omit this attribute or specify component. ColdFusion automatically sets the type to component.
]]></help>
<values>
<value option="com"/>
<value option="component"/>
<value option="corba"/>
<value option="java"/>
<value option="dotnet"/>
<value option="webservice"/>
</values>
</parameter>
<parameter name="action" required="false" type="String">
<help><![CDATA[
* create: instantiates a COM object (typically, a DLL) before invoking methods or properties.
* connect: ionnects to a COM object (typically, an EXE) running on server.
]]></help>
<values>
<value option="create"/>
<value option="connect"/>
</values>
<triggers>
<selectedValue attributeName="type" required="true" value="com"/>
<selectedValue attributeName="type" required="true" value="java"/>
</triggers>
</parameter>
<parameter name="class" required="false" type="String">
<help><![CDATA[
Component ProgID for the object to invoke. When using Java stubs to connect to the COM object, the class must be the ProgID of the COM object.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="type" required="true" value="com"/>
<selectedValue attributeName="type" required="true" value="corba"/>
<selectedValue attributeName="type" required="true" value="java"/>
</triggers>
</parameter>
<parameter name="name" required="true" returnVarType="variablename" type="String">
<help><![CDATA[
name for the instantiated component.
]]></help>
<values/>
</parameter>
<parameter name="context" required="false" type="String">
<help><![CDATA[
* inproc
* local
* remote
In Windows, if not specified, uses Registry setting.
]]></help>
<values>
<value option="inproc"/>
<value option="local"/>
<value option="remote"/>
<value option="ior"/>
<value option="nameservice"/>
</values>
<triggers>
<selectedValue attributeName="type" required="false" value="com"/>
<selectedValue attributeName="type" required="true" value="corba"/>
</triggers>
</parameter>
<parameter name="server" required="false" type="String">
<help><![CDATA[
Server name, using Universal Naming Convention (UNC) or Domain Name Serve (DNS) convention, in one of these forms:
* \\lanserver
* lanserver
* http://www.servername.com
* www.servername.com
* 127.0.0.1
]]></help>
<values/>
<triggers>
<selectedValue attributeName="context"
required="true" value="remote"/>
</triggers>
</parameter>
<parameter name="component" required="false" type="String">
<help><![CDATA[
Name of component to instantiate.
]]></help>
<values/>
</parameter>
<parameter name="locale" required="false" type="String">
<help><![CDATA[
Sets arguments for a call to init_orb. Use this attribute only for VisiBroker ORBs. It is available on C++, Version 3.2. The value must be in the form:
locale = " -ORBagentAddr 199.99.129.33 -ORBagentPort 19000"
Each type-value pair must start with a hyphen.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="type" required="false" value="corba"/>
</triggers>
</parameter>
<parameter name="webservice" required="false" type="URL">
<help><![CDATA[
One of the following:
* The absolute URL of the web service.
* The name (string) assigned in the ColdFusion Administrator to the web service.
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
The password to use to access the web service. If the webservice attribute specifies a web service name configured in the ColdFusion Administrator, overrides any password specified in the Administrator entry.
]]></help>
</parameter>
<parameter name="secure" required="false" type="Boolean">
<help><![CDATA[
Whether to secure communications with the .NET-side agent. If true, ColdFusion uses SSL to communicate with .NET.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="protocol" required="false" type="String">
<help><![CDATA[
Protocol to use to use for communication between ColdFusion and .NET. Must be one of the following values:
* http: Use HTTP/SOAP communication protocol. This option is slower than tcp, but might be required for access through a firewall.
* tcp: Use binary TCP/IP protocol. This method is more efficient than HTTP.
]]></help>
<values default="tcp">
<value option="tcp"/>
<value option="http"/>
</values>
</parameter>
<parameter name="proxyserver" required="false" type="String">
<help><![CDATA[
The proxy server required to access the web service URL.
]]></help>
</parameter>
<parameter name="refreshwsdl" required="false" type="Boolean">
<help><![CDATA[
* yes: reloads the WSDL file and regenerates the artifacts used to consume the web service
* no
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="wsportname" required="false" type="String">
<help><![CDATA[
The port name for the web service. This value is case-sensitive and corresponds to the port element's name attribute under the service element.
]]></help>
</parameter>
<parameter name="wsdl2javaargs" required="false" type="String">
<help><![CDATA[
A string that contains a space-delimited list of arguments to pass to the WSDL2Java tool that generates Java stubs for the web services.
]]></help>
</parameter>
<parameter name="proxyport" required="false" type="String">
<help><![CDATA[
The port to use on the proxy server.
]]></help>
</parameter>
<parameter name="port" required="false" type="Numeric">
<help><![CDATA[
Port number at which the .NET-side agent is listening.
]]></help>
</parameter>
<parameter name="proxypassword" required="false" type="String">
<help><![CDATA[
The user's password on the proxy server.
]]></help>
</parameter>
<parameter name="assembly" required="false" type="String">
<help><![CDATA[
For local .NET assemblies, the absolute path or paths to the assembly or assemblies (EXE or DLL files) from which to access the .NET class and its supporting classes.
For remote .NET assemblies, you must specify the absolute path or paths of the local proxy JAR file or files that represent the assemblies.
]]></help>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
The user name to use to access the web service. If the webservice attribute specifies a web service configured name in the ColdFusion Administrator, overrides any user name specified in the Administrator entry.
]]></help>
</parameter>
<parameter name="proxyuser" required="false" type="String">
<help><![CDATA[
The user ID to send to the proxy server.
]]></help>
</parameter>
<possiblecombinations>
<combination switchvalue="java">
<required>class,name</required>
<optional>action</optional>
</combination>
<combination switchvalue="component">
<required>name</required>
<optional>action,component</optional>
</combination>
<combination switchvalue="com">
<optional>action,class,context,name,server</optional>
</combination>
<combination switchvalue="corba">
<required>class,context,name</required>
<optional>locale</optional>
</combination>
<combination switchvalue="dotnet">
<required>class,name</required>
<optional>action,assembly,port,protocol,secure,server</optional>
</combination>
<combination switchvalue="webservice">
<required>name</required>
<optional>password,proxypassword,proxyport,proxyserver,proxyuser,refreshwsdl,username,webservice,wsdl2javaargs,wsportname</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfobjectcache
action = "clear"
-->
<tag endtagrequired="false" name="cfobjectcache" single="true"
xmlstyle="false">
<help><![CDATA[
Flushes the query cache.
]]></help>
<parameter isswitchattribute="true" name="action"
required="true" type="String">
<help><![CDATA[
clear: Clears queries from the cache in the Application
scope
]]></help>
<values default="clear">
<value option="clear"/>
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="clear">
<optional>action</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfoutput
query = "query_name"
group = "query_column"
groupCaseSensitive = "boolean"
startRow = "start_row"
maxRows = "max_rows_output"
/cfoutput
-->
<tag endtagrequired="true" name="cfoutput" single="false"
xmlstyle="true">
<help><![CDATA[
Displays output that can contain the results of processing
CFML variables and functions. Can loop over the results
of a database query.
]]></help>
<parameter name="query" required="false" type="query">
<help><![CDATA[
Name of cfquery from which to draw data for output section.
]]></help>
<values/>
</parameter>
<parameter name="group" required="false" type="String">
<help><![CDATA[
Query column to use to group sets of records. Eliminates
adjacent duplicate rows when data is sorted. Use if you
retrieved a record set ordered on one or more a query
columns. For example, if a record set is ordered on
"Customer_ID" in the cfquery tag, you can group the output
on "Customer_ID."
]]></help>
<values/>
</parameter>
<parameter name="groupcasesensitive" required="false" type="boolean">
<help><![CDATA[
Whether to consider the case in grouping rows.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="startrow" required="false" type="Numeric">
<help><![CDATA[
Row from which to start output.
]]></help>
<values/>
</parameter>
<parameter name="maxrows" required="false" type="Numeric">
<help><![CDATA[
Maximum number of rows to display.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfparam
name = "param_name"
type = "data_type"
default = "value"
max = "value"
min = "value"
pattern = "regular expression"
-->
<tag endtagrequired="false" canHaveAttributeCollection="false" name="cfparam" single="true"
xmlstyle="false">
<help><![CDATA[
Tests for a parameter's existence, tests its data type, and, if
a default value is not assigned, optionally provides one.
]]></help>
<return parameter="name" type="Any"/>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Name of parameter to test (such as "client.email" or
"cookie.backgroundColor"). If omitted, and if the
parameter does not exist, an error is thrown.
]]></help>
<values/>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
The valid format for the data; one of the following.
* any: any type of value.
* array: an array of values.
* binary: a binary value.
* boolean: a Boolean value: yes, no, true, false, or a number.
* creditcard: a 13-16 digit number conforming to the mod10 algorithm.
* date or time: a date-time value.
* email: a valid e-mail address.
* eurodate: a date-time value. Any date part must be in the format dd/mm/yy, The format can use /, -, or . characters as delimiters.
* float or numeric: a numeric value.
* guid: a Universally Unique Identifier of the form "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" where 'X' is a hexadecimal number.
* numeric: a numeric value
* integer: an integer.
* query: a query object.
* range: a numeric range, specified by the min and max attributes.
* regex or regular_expression: matches input against pattern attribute.
* ssn or social_security_number: a U.S. social security number.
* string: a string value or single character.
* struct: a structure.
* telephone: a standard U.S. telephone number.
* URL: an http, https, ftp, file, mailto, or news URL.
* UUID: a ColdFusion Universally Unique Identifier, formatted 'XXXXXXXX-XXXX-XXXX-XXXXXXXXXXXXXXX', where 'X' is a hexadecimal number. See CreateUUID.
* USdate: a U.S. date of the format mm/dd/yy, with 1-2 digit days and months, 1-4 digit years.
* variableName: a string formatted according to ColdFusion variable naming conventions.
* xml: XML objects and XML strings.
* zipcode: U.S., 5- or 9-digit format ZIP codes.
]]></help>
<values default="Any">
<value option="any"/>
<value option="array"/>
<value option="binary"/>
<value option="boolean"/>
<value option="creditcard"/>
<value option="date"/>
<value option="time"/>
<value option="email"/>
<value option="eurodate"/>
<value option="float"/>
<value option="numeric"/>
<value option="guid"/>
<value option="integer"/>
<value option="query"/>
<value option="range"/>
<value option="regex"/>
<value option="regular_expression"/>
<value option="ssn"/>
<value option="social_security_number"/>
<value option="string"/>
<value option="struct"/>
<value option="telephone"/>
<value option="url"/>
<value option="uuid"/>
<value option="usdate"/>
<value option="variablename"/>
<value option="xml"/>
<value option="zipcode"/>
</values>
</parameter>
<parameter name="default" required="false" type="Object">
<help><![CDATA[
Value to set parameter to if it does not exist. Any
expression used for the default attribute is evaluated,
even if the parameter exists.
The result is not assigned if the parameter exists,
but if the expression has side effects, they still occur.
]]></help>
<values/>
</parameter>
<parameter name="max" required="false" type="Numeric">
<help><![CDATA[
The maximum valid value; used only for range validation.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="type" required="false" value="range"/>
</triggers>
</parameter>
<parameter name="min" required="false" type="Numeric">
<help><![CDATA[
The minimum valid value; used only for range validation.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="type" required="false" value="range"/>
</triggers>
</parameter>
<parameter name="pattern" required="false" type="String">
<help><![CDATA[
A regular experession that the parameter must match;
used only for regex or regular_expression validation.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="type" required="false" value="Regex"/>
<selectedValue attributeName="type" required="false" value="regular_expression"/>
</triggers>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>default,max,min,pattern,type</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfpod
required
source = "path"
optional
bodyStyle = "CSS style specification"
headerStyle = "CSS style specification"
height = "number of pixels">
name = "string"
onBindError = "JavaScript function name"
title = "string"
width = "number of pixels"
OR
optional
bodyStyle = "CSS style specification"
headerStyle = "CSS style specification"
height = "number of pixels"
name = "string"
onBindError = "JavaScript function name"
title = "string"
width = "number of pixels"
pod contents
</cfpod>
-->
<tag endtagrequired="true" name="cfpod" single="false"
xmlstyle="true">
<help><![CDATA[
Creates a pod, an area of the browser window or layout
area with an optional title bar and body that contains
display elements.
]]></help>
<parameter name="bodyStyle" required="false" type="String">
<help><![CDATA[
A CSS style specification for the pod body. As a
general rule, use this attribute to set color and
font styles. Using this attribute to set the height
and width, for example, can result in distorted output.
]]></help>
<values/>
</parameter>
<parameter name="headerStyle" required="false" type="String">
<help><![CDATA[
A CSS style specification for the pod header. As a
general rule, use this attribute to set color and font
styles. Using this attribute to set the height and width,
for example, can result in distorted output.
]]></help>
<values/>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
Height if the control, including the title bar and borders,
in pixels. Default is 100.
]]></help>
<values/>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
Name of the pod control.
]]></help>
<values/>
</parameter>
<parameter name="onBindError" required="false" type="String">
<help><![CDATA[
The name of a JavaScript function to execute if
evaluating a bind expression results in an error.
The function must take two attributes: an HTTP
status code and a message. If you omit this
attribute, and have specified a global error handler
(by using the ColdFusion.setGlobalErrorHandler
function), it displays the error message; otherwise
a default error pop-up displays.
]]></help>
<values/>
</parameter>
<parameter name="overflow" required="false" type="String">
<help><![CDATA[
Specifies how to display child content whose size
would cause the control to overflow the pod
boundaries. Note: In Internet Explorer, pods
with the visible setting expand to fit the size of
the contents, rather than having the contents extend
beyond the layout area.
]]></help>
<values default="auto">
<value option="auto"/>
<value option="hidden"/>
<value option="scroll"/>
<value option="visible"/>
</values>
</parameter>
<parameter name="source" required="false" type="String">
<help><![CDATA[
A URL that returns the pod contents. ColdFusion
uses standard page path resolution rules. If you
specify this attribute and the cfpod tag has a body,
ColdFusion ignores the body contents. You can use a a
bind expression with dependencies in this
attribute; for more information see the Usage section.
Note: If a CFML page specified in this attribute contains
tags that use AJAX features, such as cfform, cfgrid,
and cfwindow, you must use a cfajaximport tag on the
page with the cfpod tag.
For more information, see cfajaximport.
]]></help>
<values/>
</parameter>
<parameter name="title" required="false" type="String">
<help><![CDATA[
Text to display in the pod�s title bar. You can use
HTML mark up to control the title appearance, of
example to show the text in red italic font.
If you omit this attribute, the pod does not
have a title bar.
]]></help>
<values/>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Width if the control, including the title bar and
borders, in pixels. Default is 500.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfpop
server = "servername"
port = "port_number"
username = "username"
password = "password"
action = "action"
name = "queryname"
messageNumber = "number"
uid = "number"
attachmentPath = "path"
timeout = "seconds"
maxRows = "number"
startRow = "number"
generateUniqueFilenames = "boolean"
-->
<tag endtagrequired="false" name="cfpop" single="true"
xmlstyle="false">
<return parameter="name" type="cfpop"/>
<help><![CDATA[
Retrieves or deletes e-mail messages from a POP mail server.
]]></help>
<return parameter="name" type="variablename"/>
<parameter name="server" required="true" type="String">
<help><![CDATA[
POP server identifier:
A host name; for example, "biff.upperlip.com"
An IP address; for example, "192.1.2.225"
]]></help>
<values/>
</parameter>
<parameter name="port" required="false" type="Numeric">
<help><![CDATA[
POP port
]]></help>
<values/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
Overrides username.
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Overrides password
]]></help>
<values/>
</parameter>
<parameter isswitchattribute="true" name="action"
required="false" type="String">
<help><![CDATA[
getHeaderOnly: returns message header information only
getAll: returns message header information, message text,
and attachments if attachmentPath is specified
delete: deletes messages on POP server
]]></help>
<values>
<value option="getHeaderOnly"/>
<value option="getAll"/>
<value option="delete"/>
</values>
</parameter>
<parameter name="name" required="false" returnVarType="query" type="String">
<help><![CDATA[
Name for query object that contains the retrieved message
information.
]]></help>
<values/>
</parameter>
<parameter name="messagenumber" required="false" type="Numeric">
<help><![CDATA[
Message number or comma-delimited list of message numbers
to get or delete. Invalid message numbers are ignored.
Ignored if uid is specified.
]]></help>
<values/>
</parameter>
<parameter name="uid" required="false" type="String">
<help><![CDATA[
UID or a comma-delimited list of UIDs to get or delete.
Invalid UIDs are ignored.
]]></help>
<values/>
</parameter>
<parameter name="attachmentpath" required="false" type="String">
<help><![CDATA[
If action="getAll", specifies a directory in which to save
any attachments. If the directory does not exist,
CFML creates it.
If you omit this attribute, CFML does not save any
attachments. If you specify a relative path, the path root
is the CFML temporary directory, which is returned by
the GetTempDirectory function.
]]></help>
<values/>
</parameter>
<parameter name="timeout" required="false" type="Numeric">
<help><![CDATA[
Maximum time, in seconds, to wait for mail processing
]]></help>
<values/>
</parameter>
<parameter name="maxrows" required="false" type="Numeric">
<help><![CDATA[
Number of messages to return or delete, starting with the
number in startRow. Ignored if messageNumber or uid is
specified.
]]></help>
<values/>
</parameter>
<parameter name="startrow" required="false" type="Numeric">
<help><![CDATA[
First row number to get or delete. Ignored if messageNumber
or uid is specified.
]]></help>
<values/>
</parameter>
<parameter name="generateUniqueFileNames" required="false" type="boolean">
<help><![CDATA[
Yes: Generate unique filenames for files attached to an
e-mail message, to avoid naming conflicts when files are
saved
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="getall">
<required>name,server</required>
<optional>attachmentpath,generateuniquefilenames,maxrows,messagenumber,password,port,startrow,timeout,uid,username</optional>
</combination>
<combination switchvalue="getheaderonly">
<required>name,server</required>
<optional>maxrows,messagenumber,password,port,startrow,timeout,uid,username</optional>
</combination>
<combination switchvalue="delete">
<required>server</required>
<optional>messagenumber,password,port,timeout,uid,username</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfprocessingdirective
pageencoding = "page-encoding literal string"
/
or
cfprocessingdirective
suppressWhiteSpace = "boolean"
pageEncoding = "page-encoding literal string"
[CFML tags]
/cfprocessingdirective
-->
<tag endtagrequired="true" canHaveAttributeCollection="false" name="cfprocessingdirective"
single="false"
xmlstyle="false">
<help><![CDATA[
Provides the following insformation to CFML on how to
process the current page:
* Specifies whether to remove excess whitespace character from
CFML generated content in the tag body.
* Identifies the character encoding (character set) of the page
contents.
]]></help>
<parameter name="suppressWhitespace" required="false" type="boolean">
<help><![CDATA[
Boolean; whether to suppress white space characters within
the cfprocessingdirective block that are generated by CFML
tags and often do not affect HTML appearance. Does not
affect any white space in HTML code.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="pageEncoding" required="false" type="String">
<help><![CDATA[
A string literal; cannot be a variable. Identifies the
character encoding of the current CFML page. This attribute
affects the entire page, not just the cfprocessing tag body.
The value may be enclosed in single or double quotation
marks, or none.
For more information on character encodings, see:
www.w3.org/International/O-charset.html.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfprocparam
type = "in" or "out" or "inout"
variable = "variable name"
value = "parameter value"
CFSQLType = "parameter datatype"
maxLength = "length"
scale = "decimal places"
null = "boolean"
-->
<tag endtagrequired="false" name="cfprocparam" single="true"
xmlstyle="false">
<help><![CDATA[
Defines stored procedure parameters. This tag is nested within
a cfstoredproc tag.
]]></help>
<parameter name="type" required="false" type="String">
<help><![CDATA[
in: The parameter is used to send data to the database
system only. Passes the parameter by value.
out: The parameter is used to receive data from the
database system only. Passes the parameter as a bound
variable.
inout: The parameter is used to send and receive data.
Passes the parameter as a bound variable.
]]></help>
<values default="in">
<value option="in"/>
<value option="out"/>
<value option="inout"/>
</values>
</parameter>
<parameter name="variable" required="false" type="String">
<help><![CDATA[
CFML variable name; references the value that the
output parameter has after the stored procedure is called.
]]></help>
<values/>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
Value that CFML passes to the stored procedure.
]]></help>
<values/>
</parameter>
<parameter name="cfsqltype" required="true" type="String">
<help><![CDATA[
SQL type to which the parameter (any type) is bound.
CFML supports the following values, where the last
element of the name corresponds to the SQL data type.
Different database systems might support different subsets
of this list. See your DBMS documentation for information
on supported parameter types.
]]></help>
<values>
<value option="CF_SQL_BIGINT"/>
<value option="CF_SQL_BIT"/>
<value option="CF_SQL_CHAR"/>
<value option="CF_SQL_BLOB"/>
<value option="CF_SQL_CLOB"/>
<value option="CF_SQL_DATE"/>
<value option="CF_SQL_DECIMAL"/>
<value option="CF_SQL_DOUBLE"/>
<value option="CF_SQL_FLOAT"/>
<value option="CF_SQL_IDSTAMP"/>
<value option="CF_SQL_INTEGER"/>
<value option="CF_SQL_LONGVARCHAR"/>
<value option="CF_SQL_MONEY"/>
<value option="CF_SQL_MONEY4"/>
<value option="CF_SQL_NUMERIC"/>
<value option="CF_SQL_REAL"/>
<value option="CF_SQL_REFCURSOR"/>
<value option="CF_SQL_SMALLINT"/>
<value option="CF_SQL_TIME"/>
<value option="CF_SQL_TIMESTAMP"/>
<value option="CF_SQL_TINYINT"/>
<value option="CF_SQL_VARCHAR"/>
</values>
</parameter>
<parameter name="maxlength" required="false" type="Numeric">
<help><![CDATA[
Maximum length of a string or character IN or INOUT value
attribute. A maxLength of 0 allows any length. The
maxLength attribute is not required when specifying
type=out.
]]></help>
<values default="0"/>
</parameter>
<parameter name="scale" required="false" type="Numeric">
<help><![CDATA[
Number of decimal places in numeric parameter. A scale of 0
allows any number of decimal places.
]]></help>
<values default="0"/>
</parameter>
<parameter name="null" required="false" type="boolean">
<help><![CDATA[
Whether the parameter is passed in as a null value. Not
used with OUT type parameters.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations>
<combination attributename="cfsqltype">
<required>cfsqltype</required>
<optional>bvarname,maxlength,null,scale,type,value,variable</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfprocresult
name = "query_name"
resultSet = "1-n"
maxRows = "maxrows"
-->
<tag endtagrequired="false" name="cfprocresult" single="true"
xmlstyle="false">
<return parameter="name" type="query"/>
<help><![CDATA[
Associates a query object with a result set returned by a
stored procedure. Other CFML tags, such as cfoutput and
cftable, use this query object to access the result set. This
tag is nested within a cfstoredproc tag.
]]></help>
<parameter name="name" required="true" returnVarType="query" type="String">
<help><![CDATA[
Name for the query result set.
]]></help>
<values/>
</parameter>
<parameter name="resultset" required="false" type="Numeric">
<help><![CDATA[
Names one result set, if stored procedure returns more than
one.
]]></help>
<values/>
</parameter>
<parameter name="maxrows" required="false" type="Numeric">
<help><![CDATA[
Maximum number of rows returned in result set.
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>maxrows,resultset</optional>
</combination>
</possiblecombinations>
</tag>
<tag allowanyattribute="true" canHaveAttributeCollection="false" endtagrequired="false"
name="cfproperty" single="true"
xmlstyle="false">
<help><![CDATA[
Defines properties of a CFML component (CFC). Used to
create complex data types for web services. The attributes of
this tag are exposed as component metadata and are subject to
inheritance rules.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Specifies the name of the property.
]]></help>
<values/>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
Specifies the ColdFusion data type for the property.
]]></help>
<values>
<value option="any"/>
<value option="array"/>
<value option="binary"/>
<value option="boolean"/>
<value option="date"/>
<value option="guid"/>
<value option="numeric"/>
<value option="query"/>
<value option="string"/>
<value option="struct"/>
<value option="uuid"/>
<value option="variablename"/>
</values>
</parameter>
<parameter name="required" required="false" type="boolean">
<help><![CDATA[
Whether the parameter is required
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="default" required="false" type="String">
<help><![CDATA[
This sets the default value on the property when the object is created.
]]></help>
<values />
</parameter>
<parameter name="displayname" required="false" type="String">
<help><![CDATA[
A value to be displayed when using introspection to show
information about the CFC. The value appears in parentheses
following the property name.
]]></help>
<values/>
</parameter>
<parameter name="hint" required="false" type="String">
<help><![CDATA[
Text to be displayed when using introspection to show
information about the CFC. This attribute can be useful
for describing the purpose of the parameter.
]]></help>
<values/>
</parameter>
<parameter name="fieldtype" required="false" type="String">
<help><![CDATA[
This attribute is used to specify the type of the property. Use this attribute to specify the following:
* Primary key: Specify fieldtype = "id" to map a property to the primary key in the table.
* Column: Specify the fieldtype = "column" to map a property to a column in the table.
* Relationship: Specify the fieldtype = "relationship_type". The relationship_type can be one-to-one, one-to-many, many-to-one, or many-to-many.
* Version: Specify the fieldtype="version” to indicate that the column contains versioned data.
* Timestamp: Specify the fieldtype="timestamp" to indicate the column contains data with timestamp.
* Collection: Specify the fieldtype="collection" to define the collection mapping.
]]></help>
<values >
<value option="id" />
<value option="column" />
<value option="one-to-one" />
<value option="one-to-many" />
<value option="many-to-many" />
<value option="many-to-one" />
<value option="collection" />
<value option="timestamp" />
<value option="version" />
</values>
</parameter>
<parameter name="ormType" required="false" type="String">
<help><![CDATA[
Used to specify the data type of the primary key. If data type is not set and the ORM setting
useDBForMapping=true, then the ormtype is determined by inspecting the database.
]]></help>
<values >
<value option="string" />
<value option="character" />
<value option="char" />
<value option="short" />
<value option="integer" />
<value option="int" />
<value option="long" />
<value option="big_decimal" />
<value option="float" />
<value option="double" />
<value option="boolean" />
<value option="yes_no" />
<value option="true_false" />
<value option="text" />
<value option="date" />
<value option="timestamp" />
<value option="binary" />
<value option="serializable" />
<value option="blob" />
<value option="clob" />
<!--<value option="imm_timestamp" />
<value option="imm_calendar" />
<value option="imm_calendar_date" />
<value option="imm_serializable" />
<value option="imm_binary" /> -->
</values>
</parameter>
<parameter name="column" required="false" type="String">
<help><![CDATA[
Used to specify the primary key column name.
]]></help>
<values/>
</parameter>
<parameter name="generator" required="false" type="String">
<help><![CDATA[
Algorithm used to generate unique identifiers for instances of the persistent CFC.
]]></help>
<values>
<value option="increment"/>
<value option="identity"/>
<value option="sequence"/>
<value option="seqhilo"/>
<value option="uuid"/>
<value option="guid"/>
<value option="native"/>
<value option="assigned"/>
<value option="select"/>
<value option="foreign"/>
<value option="sequence-indentity"/>
</values>
</parameter>
<parameter name="sequence" required="false" type="String">
<help><![CDATA[
Sequence key name in the database.
]]></help>
<values/>
</parameter>
<parameter name="selectkey" required="false" type="String">
<help><![CDATA[
The column name that is used to retrieve the primary key generated by a database trigger.
]]></help>
<values/>
</parameter>
<parameter name="params" required="false" type="String">
<help><![CDATA[
Additional parameters required by the various generators to generate the ID.
The value for the params attribute should follow the CF Struct syntax. For example: params = {key1='value1', key2='value2'}
]]></help>
<values/>
</parameter>
<parameter name="length" required="false" type="String">
<help><![CDATA[
Use this attribute to specify the length of the column. This attribute is used for table creation only.
]]></help>
<values/>
</parameter>
<parameter name="precision" required="false" type="String">
<help><![CDATA[
Specifies the precision value.
]]></help>
<values/>
</parameter>
<parameter name="index" required="false" type="String">
<help><![CDATA[
Specifies the name of an index that is created using the mapped column
]]></help>
<values/>
</parameter>
<parameter name="setter" required="false" type="Boolean">
<help><![CDATA[
Specifies whether to generate setter methods or not
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="getter" required="false" type="Boolean">
<help><![CDATA[
Specifies whether to generate getter methods or not
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="source" required="false" type="String">
<help><![CDATA[
Specifies the source from where the timestamp has to be retrieved
]]></help>
<values default="vm" >
<value option="vm"/>
<value option="db"/>
</values>
</parameter>
<parameter name="elementcolumn" required="false" type="String">
<help><![CDATA[
Column name in the table that is used as value in struct.
]]></help>
<values/>
</parameter>
<parameter name="elementtype" required="false" type="String">
<help><![CDATA[
Data type of the value.
]]></help>
<values >
<value option="string" />
<value option="character" />
<value option="char" />
<value option="short" />
<value option="integer" />
<value option="int" />
<value option="long" />
<value option="big_decimal" />
<value option="float" />
<value option="double" />
<value option="boolean" />
<value option="yes_no" />
<value option="true_false" />
<value option="text" />
<value option="date" />
<value option="timestamp" />
<value option="binary" />
<value option="serializable" />
<value option="blob" />
<value option="clob" />
</values>
</parameter>
<parameter name="structkeytype" required="false" type="String">
<help><![CDATA[
Specifies the data type of the key, when collectiontype=struct.
]]></help>
<values >
<value option="string" />
<value option="character" />
<value option="char" />
<value option="short" />
<value option="integer" />
<value option="int" />
<value option="long" />
<value option="big_decimal" />
<value option="float" />
<value option="double" />
<value option="boolean" />
<value option="yes_no" />
<value option="true_false" />
<value option="text" />
<value option="date" />
<value option="timestamp" />
<value option="binary" />
<value option="serializable" />
<value option="blob" />
<value option="clob" /></values>
</parameter>
<parameter name="structkeycolumn" required="false" type="String">
<help><![CDATA[
The column in the target table to use as key if the collection type is struct.
]]></help>
<values/>
</parameter>
<parameter name="inversejoincolumn" required="false" type="String">
<help><![CDATA[
Specifies the foreign key column in the Join table that references the primary key column in the target table.
]]></help>
<values/>
</parameter>
<parameter name="linkschema" required="false" type="String">
<help><![CDATA[
Schema for the link table
]]></help>
<values/>
</parameter>
<parameter name="linkcatalog" required="false" type="String">
<help><![CDATA[
Catalog for the link table
]]></help>
<values/>
</parameter>
<parameter name="linktable" required="false" type="String">
<help><![CDATA[
Name of the link table
]]></help>
<values/>
</parameter>
<parameter name="missingRowIgnored" required="false" type="Boolean">
<help><![CDATA[
If the value is true, and the row that is referenced by the foreign key is missing, it is treated as a null
association. The default is false, in which case an exception occurs.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="inverse" required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies bidirectional association
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="orderby" required="false" type="String">
<help><![CDATA[
Specifies the Order By string.
]]></help>
<values/>
</parameter>
<parameter name="fkcolumn" required="false" type="String">
<help><![CDATA[
Specifies the foreign key column
]]></help>
<values/>
</parameter>
<parameter name="fetch" required="false" type="String">
<help><![CDATA[
Specifies if it is outer-join fetching or sequential select fetching
]]></help>
<values>
<value option="join"/>
<value option="select"/>
</values>
</parameter>
<parameter name="cascade" required="false" type="String">
<help><![CDATA[
Specifies which operations should be cascaded from the parent object to the associated object
]]></help>
<values>
<value option="all"/>
<value option="none"/>
<value option="save-update"/>
<value option="delete"/>
<value option="all-delete-orphan"/>
<value option="delete-orphan"/>
<value option="create"/>
<value option="merge"/>
<value option="lock"/>
<value option="refresh"/>
<value option="evict"/>
<value option="replicate"/>
</values>
</parameter>
<parameter name="constrained" required="false" type="Boolean">
<help><![CDATA[
Whether a constraint is set on this table's Primary Key column to reference the Primary Key in the other table
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="unique" required="false" type="String">
<help><![CDATA[
Specifies if there should be a unique constraint on the column.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="uniquekey" required="false" type="String">
<help><![CDATA[
Groups columns in a single unique key constraint.
]]></help>
<values/>
</parameter>
<parameter name="notnull" required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies whether a notnull constriant should be added for this column.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="update" required="false" type="String">
<help><![CDATA[
Whether the column should be included in the SQL update statement.
Set update=false and insert=false if the column needs to be read-only.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="insert" required="false" type="Boolean">
<help><![CDATA[
Whether the column should be included in SQL UPDATE and/or INSERT tatements.
Set update=false and insert=false if the column needs to be read-only.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="generated" required="false" type="String">
<help><![CDATA[
Specifies that this property value is actually generated by the database {never|always|insert}
* never: Specifies that the value for this property is never generated by database
* always: Specifies that the value for this property is always generated by database
* insert: Specifies that the value for this property is generated at the time of insert but is not regenerated at updates.
]]></help>
<values>
<value option="never"/>
<value option="insert"/>
<value option="always" />
</values>
</parameter>
<parameter name="formula" required="false" type="String">
<help><![CDATA[
SQL expression that defines the value of the property.If you specify a formula, the column value is ignored.
]]></help>
<values/>
</parameter>
<parameter name="lazy" required="false" type="String">
<help><![CDATA[
Specifies if loading is to be done by parts:
]]></help>
<values>
<value option="true"/>
<value option="false"/>
<value option="extra"/>
</values>
</parameter>
<parameter name="optimisticLock" required="false" type="Boolean">
<help><![CDATA[
Whether updates to this property require acquisition of the optimistic lock on the table row
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="scale" required="false" type="String">
<help><![CDATA[
Specifies the scale value
]]></help>
</parameter>
<parameter name="mappedby" required="false" type="String">
<help><![CDATA[
Property in the target CFC that is referenced by the foreign key in the Join table.
]]></help>
</parameter>
<parameter name="cfc" required="false" type="String">
<help><![CDATA[
Name of referenced CFC
]]></help>
</parameter>
<parameter name="joinColumn" required="false" type="String">
<help><![CDATA[
Use this attribute to define the join column for inheritance mapping.
]]></help>
</parameter>
<parameter name="validate" required="false" type="String">
<help><![CDATA[
Takes the validator to be used for validating data when implicit setter for this property is called.
]]></help>
<values>
<value option="string" />
<value option="boolean" />
<value option="integer" />
<value option="numeric" />
<value option="date" />
<value option="time" />
<value option="creditcard" />
<value option="email" />
<value option="eurodate" />
<value option="ssn" />
<value option="telephone" />
<value option="UUID" />
<value option="guid" />
<value option="zipcode" />
</values>
</parameter>
<parameter name="validateParams" required="false" type="String">
<help><![CDATA[
Takes the parameters required by the validator specified in the validate attribute.
This should be specified in the implicit struct notation eg. validateparams="{min=18,max=60}">.
min: Minimum value if validate is integer/numeric/
max: Maximum value if the validate is integer/numeric/
minLength: Minimum length of the string if the validate is string
minLength: Maximum length of the string if the validate is string
pattern: regex expression if the validator specified in validate attribute is regex
]]></help>
</parameter>
<parameter name="cacheUse" required="false" type="String">
<help><![CDATA[
Type of cache to use
]]></help>
<values>
<value option="read-only" />
<value option="nonstrict-read-write" />
<value option="read-write" />
<value option="transactional" />
</values>
</parameter>
<parameter name="sqlType" required="false" type="String">
<help><![CDATA[
Use this attribute to specify the DB-specific SQLType that should be used for the column. This attribute is used for table creation only.
If this attribute is not specified, ColdFusion will automatically decide the SQLType based on the ormtype specified for this property.
]]></help>
<values/>
</parameter>
<parameter name="dbDefault" required="false" type="String">
<help><![CDATA[
This sets the default value of a column in the table when schema is exported.
]]></help>
<values/>
</parameter>
<parameter name="where" required="false" type="String">
<help><![CDATA[
Where condition
]]></help>
<values/>
</parameter>
<parameter name="persistent" required="false" type="Boolean">
<help><![CDATA[
Specifies whether this property should be persisted. If
persistent="false” all the ORM related attributes are ignored.
Set this attribute to false if you do not want this property to be persisted by ORM.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="unSavedValue" required="false" type="String">
<help><![CDATA[
An identifier property value that indicates that an instance is newly instantiated and not saved/loaded in the database
]]></help>
<values/>
</parameter>
<parameter name="serializable" required="false" type="Boolean">
<help><![CDATA[
Specifies whether this property can be serialized. If you set this value to
false, the property cannot be serialized, so any changes made are not retained on session replication, and the property has its default value (if any) on the second server.
Use this attribute to prevent serializaton of properties in CFCs that are serializable.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="singularname" required="false" type="String">
<help><![CDATA[
Use this prperty to define the custom name for generated relationship methods. Applies to one-to-many and many-to-many
]]></help>
</parameter>
<parameter name="remotingFetch" required="false" type="Boolean">
<help><![CDATA[
If remotingFetch is false, then the value of that attribute is not sent over flash remoting. remotingFetch is true by default was all properties. But in case of cfcs for which persistent = true, the value of the remotingFetch attribute is false by default for any property that shares one-to-one, one-to-many, many-to-one or many-to-many relationship.
]]></help>
<values >
<value option="false" />
<value option="true" />
</values>
</parameter>
<parameter name="table" required="false" type="String">
<help><![CDATA[
Table name
]]></help>
<values/>
</parameter>
</tag>
<tag endtagrequired="true" name="cfquery" single="false"
xmlstyle="false">
<help><![CDATA[
Passes queries or SQL statements to a data source.
It is recommended that you use the cfqueryparam tag within
every cfquery tag, to help secure your databases from
unauthorized users
]]></help>
<return parameter="name" type="query"/>
<return parameter="result" type="cfquery"/>
<parameter name="name" required="false" returnVarType="query" type="String">
<help><![CDATA[
Name of query. Used in page to reference query record set.
Must begin with a letter. Can include letters, numbers,
and underscores.
]]></help>
<values/>
</parameter>
<parameter name="datasource" required="false" type="String">
<help><![CDATA[
Name of data source from which query gets data.
]]></help>
<values/>
</parameter>
<parameter name="dbtype" required="false" type="String">
<help><![CDATA[
query. Use this value to specify the results of a query as
input.
]]></help>
<values/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
Overrides username in data source setup.
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Overrides password in data source setup.
]]></help>
<values/>
</parameter>
<parameter name="maxrows" required="false" type="Numeric">
<help><![CDATA[
Maximum number of rows to return in record set.
-1 returns all records.
]]></help>
<values default="-1"/>
</parameter>
<parameter name="blockfactor" required="false" type="Numeric">
<help><![CDATA[
Maximum rows to get at a time from server. Range: 1 - 100.
Might not be supported by some database systems.
]]></help>
<values/>
</parameter>
<parameter name="timeout" required="false" type="Numeric">
<help><![CDATA[
Maximum number of seconds that each action of a query is
permitted to execute before returning an error. The
cumulative time may exceed this value.
For JDBC statements, CFML sets this attribute. For
other drivers, check driver documentation.
]]></help>
<values/>
</parameter>
<parameter name="cachedafter" required="false" type="DateTime">
<help><![CDATA[
Date value (for example, April 16, 1999, 4-16-99). If date
of original query is after this date, CFML uses
cached query data. To use cached data, current query must
use same SQL statement, data source, query name, user name,
password.
A date/time object is in the range 100 AD-9999 AD.
When specifying a date value as a string, you must enclose
it in quotation marks.
]]></help>
<values/>
</parameter>
<parameter name="cachedwithin" required="false" type="Timespan">
<help><![CDATA[
Timespan, using the CreateTimeSpan function. If original
query date falls within the time span, cached query data is
used. CreateTimeSpan defines a period from the present,
back. Takes effect only if query caching is enabled in the
Administrator.
To use cached data, the current query must use the same SQL
statement, data source, query name, user name, and password.
]]></help>
<values/>
</parameter>
<parameter name="debug" required="false" type="boolean">
<help><![CDATA[
Yes: If debugging is enabled, but the Administrator
Database Activity option is not enabled, displays SQL
submitted to datasource and number of records returned
by query.
No: If the Administrator Database Activity option is
enabled, suppresses display.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="result" required="false" returnVarType="Struct" type="String">
<help><![CDATA[
Specifies a name for the structure in which cfquery returns
the result variables.
* SQL: The SQL statement that was executed. (string)
* Cached: If the query was cached. (boolean)
* SqlParameters: An ordered Array of cfqueryparam values. (array)
* RecordCount: Total number of records in the query. (numeric)
* ColumnList: Column list, comma seperated. (numeric)
* ExecutionTime: Execution time for the SQL request. (numeric)
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfqueryparam
value = "parameter value"
CFSQLType = "parameter type"
maxLength = "maximum parameter length"
scale = "number of decimal places"
null = "boolean"
list = "boolean"
separator = "separator character"
-->
<tag endtagrequired="false" name="cfqueryparam" single="true"
xmlstyle="false">
<help><![CDATA[
Verifies the data type of a query parameter and, for DBMSs that
support bind variables, enables CFML to use bind variables
in the SQL statement. Bind variable usage enhances performance
when executing a cfquery statement multiple times.
This tag is nested within a cfquery tag, embedded in a query SQL
statement. If you specify optional parameters, this tag performs
data validation.
]]></help>
<parameter name="value" required="false" type="String">
<help><![CDATA[
Value that CFML passes to the right of the comparison
operator in a where clause.
If CFSQLType is a date or time option, ensure that the date
value uses your DBMS-specific date format. Use the
CreateODBCDateTime or DateFormat and TimeFormat functions
to format the date value.
]]></help>
<values/>
</parameter>
<parameter name="cfsqltype" required="false" type="String">
<help><![CDATA[
SQL type that parameter (any type) is bound to.
]]></help>
<values>
<value option="cf_sql_bigint"/>
<value option="cf_sql_bit"/>
<value option="cf_sql_char"/>
<value option="cf_sql_blob"/>
<value option="cf_sql_clob"/>
<value option="cf_sql_date"/>
<value option="cf_sql_decimal"/>
<value option="cf_sql_double"/>
<value option="cf_sql_float"/>
<value option="cf_sql_idstamp"/>
<value option="cf_sql_integer"/>
<value option="cf_sql_longvarchar"/>
<value option="cf_sql_money"/>
<value option="cf_sql_money4"/>
<value option="cf_sql_numeric"/>
<value option="cf_sql_real"/>
<value option="cf_sql_refcursor"/>
<value option="cf_sql_smallint"/>
<value option="cf_sql_time"/>
<value option="cf_sql_timestamp"/>
<value option="cf_sql_tinyint"/>
<value option="cf_sql_varchar"/>
</values>
</parameter>
<parameter name="maxlength" required="false" type="Numeric">
<help><![CDATA[
Maximum length of parameter.
]]></help>
<values/>
</parameter>
<parameter name="scale" required="false" type="Numeric">
<help><![CDATA[
Number of decimal places in parameter. Applies to
CF_SQL_NUMERIC and CF_SQL_DECIMAL.
]]></help>
<values/>
</parameter>
<parameter name="null" required="false" type="boolean">
<help><![CDATA[
Whether parameter is passed as a null value.
Yes: tag ignores the value attribute
No: does not
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="list" required="false" type="boolean">
<help><![CDATA[
Yes: The value attribute value is a delimited list
No: it is not
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="separator" required="false" type="char">
<help><![CDATA[
Character that separates values in list, in value attribute.
]]></help>
<values>
<value option=","/>
<value option=";"/>
<value option="|"/>
<value option=":"/>
</values>
</parameter>
<possiblecombinations/>
</tag>
<tag endtagrequired="false" name="cfregistry" single="true"
xmlstyle="false">
<help><![CDATA[
Reads, writes, and deletes keys and values in the system registry.
Provides persistent storage of client variables.
This tag is deprecated for the UNIX platform.
Note: For this tag to execute, it must be enabled in the ColdFusion MX
Administrator.
]]></help>
<return type="query" parameter="name"/>
<return type="variablename" parameter="variable"/>
<parameter isswitchattribute="true" name="action"
required="true" type="String">
<help><![CDATA[
Action to perform
]]></help>
<values>
<value option="getAll"/>
<value option="get"/>
<value option="set"/>
<value option="delete"/>
</values>
</parameter>
<parameter name="branch" required="false" type="String">
<help><![CDATA[
Name of a registry branch.
]]></help>
<values/>
</parameter>
<parameter name="entry" required="false" type="String">
<help><![CDATA[
Registry value to access.
Note: For key deletion this attribute is required.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="get"/>
<selectedValue attributeName="action"
required="true" value="set"/>
</triggers>
</parameter>
<parameter name="variable" returnVarType="variablename" required="false" type="String">
<help><![CDATA[
Variable into which to put value.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="get"/>
</triggers>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
* string: returns string values.
* dWord: returns DWord values.
* key: returns keys.
* any: returns keys and values.
]]></help>
<values default="String">
<value option="String"/>
<value option="dWord"/>
<value option="key"/>
<value option="Any"/>
</values>
</parameter>
<parameter name="sort" required="false" type="String">
<help><![CDATA[
Sorts query column data (case-insensitive). Sorts on Entry, Type,
and Value columns as text. Specify a combination of columns from
query output, in a comma-delimited list.
For example: sort = "value desc, entry asc"
* asc: ascending (a to z) sort order.
* desc: descending (z to a) sort order.
]]></help>
<values>
<value option="entry asc"/>
<value option="entry desc"/>
<value option="type asc"/>
<value option="type desc"/>
<value option="value asc"/>
<value option="value desc"/>
</values>
</parameter>
<parameter name="directory" required="false" type="String">
<help><![CDATA[
Absolute pathname of directory against which to perform
action.
]]></help>
<values/>
</parameter>
<parameter name="name" returnVarType="query" required="false" type="String">
<help><![CDATA[
Name for output record set.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="list"/>
</triggers>
</parameter>
<parameter name="mode" required="false" type="String">
<help><![CDATA[
Applies only to UNIX and Linux. Permissions. Octal values
of Unix chmod command. Assigned to owner, group, and
other, respectively.
]]></help>
<values/>
</parameter>
<parameter name="newdirectory" required="false" type="String">
<help><![CDATA[
New name for directory.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="rename"/>
</triggers>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
Value data to set. If you omit this attribute, the cfregistry tag creates default value, as follows:
* string: creates an empty string: "".
* dWord: creates a value of 0 (zero).
]]></help>
<values/>
</parameter>
<parameter name="recurse" required="false" type="boolean">
<help><![CDATA[
Whether ColdFusion performs the action on subdirectories.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="list"/>
<selectedValue attributeName="action"
required="false" value="delete"/>
</triggers>
</parameter>
<possiblecombinations>
<combination switchvalue="set">
<required>branch,entry</required>
<optional>type,value</optional>
</combination>
<combination switchvalue="getall">
<required>branch,name</required>
<optional>entry,sort,type,variable</optional>
</combination>
<combination switchvalue="get">
<required>branch,entry,variable</required>
<optional>name,sort,type</optional>
</combination>
<combination switchvalue="delete">
<required>branch</required>
<optional>entry,type</optional>
</combination>
</possiblecombinations>
<parameter name="registryversion" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</tag>
<tag endtagrequired="false" name="cfreport" single="false"
xmlstyle="false">
<help><![CDATA[
Used to do either of the following:
- Execute a report definition created with the ColdFusion
Report Builder, displaying it in PDF, FlashPaper, or Excel
format. You can optionally save this report to a file.
- Run a predefined Crystal Reports report. Applies only to
Windows systems. Uses the CFCRYSTAL.exe file to generate
reports. Sets parameters in the Crystal Reports engine
according to its attribute values.
]]></help>
<return parameter="name" type="Any"/>
<parameter name="template" required="false" type="String">
<help><![CDATA[
Specifies the path to the report definition file,
relative to the web root.
]]></help>
<values/>
</parameter>
<parameter name="format" required="false" type="String">
<help><![CDATA[
Specifies the output format.
]]></help>
<values>
<value option="PDF"/>
<value option="FlashPaper"/>
<value option="Excel"/>
<value option="RTF"/>
<value option="HTML"/>
<value option="XML"/>
</values>
</parameter>
<parameter name="name" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
The name of the ColdFusion variable that will hold
the report output. You cannot specify both name and
filename.
]]></help>
<values/>
</parameter>
<parameter name="filename" required="false" type="String">
<help><![CDATA[
The filename to contain the report. You cannot
specify both name and filename.
]]></help>
<values/>
</parameter>
<parameter name="query" required="false" type="String">
<help><![CDATA[
The name of the query that contains input data for
the report. If you omit this parameter, the report
definition obtains data from the internal SQL or from
cfreportparam items.
]]></help>
<values/>
</parameter>
<parameter name="overwrite" required="false" type="boolean">
<help><![CDATA[
Specifies whether to overwrite files that have the
same name as that specified in the filename attribute.
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="encryption" required="false" type="String">
<help><![CDATA[
Specifies whether the output is encrypted. PDF format only.
Default: none
]]></help>
<values default="none">
<value option="128-bit"/>
<value option="40-bit"/>
<value option="none"/>
</values>
</parameter>
<parameter name="ownerpassword" required="false" type="String">
<help><![CDATA[
Specifies an owner password. PDF format only.
]]></help>
<values/>
</parameter>
<parameter name="userpassword" required="false" type="String">
<help><![CDATA[
Specifies a user password. PDF format only.
]]></help>
<values/>
</parameter>
<parameter name="permissions" required="false" type="String">
<help><![CDATA[
Specifies one or more permissions. PDF format only.
Separate multiple permissions with a comma.
]]></help>
<values>
<value option="AllowPrinting,AllowCopy,AllowScreenReaders"/>
<value option="AllowPrinting"/>
<value option="AllowModifyContents"/>
<value option="AllowCopy"/>
<value option="AllowModifyAnnotations"/>
<value option="AllowFillIn"/>
<value option="AllowScreenReaders"/>
<value option="AllowAssembly"/>
<value option="AllowDegradedPrinting"/>
<value option="AllowPrinting,AllowModifyContents,AllowCopy,AllowModifyAnnotations,AllowFillIn,AllowScreenReaders,AllowAssembly,AllowDegradedPrinting"/>
</values>
</parameter>
<parameter name="datasource" required="false" type="String">
<help><![CDATA[
Name of registered or native data source.
]]></help>
<values/>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
* standard (not valid for Crystal Reports 8.0)
* netscape
* microsoft
]]></help>
<values default="standard">
<value option="standard"/>
<value option="netscape"/>
<value option="microsoft"/>
</values>
</parameter>
<parameter name="timeout" required="false" type="Numeric">
<help><![CDATA[
Maximum time, in seconds, in which a connection must be
made to a Crystal Report.
]]></help>
<values/>
</parameter>
<parameter name="report" required="false" type="String">
<help><![CDATA[
Report path. Store Crystal Reports files in the same
directories as CFML page files.
]]></help>
<values/>
</parameter>
<parameter name="orderby" required="false" type="String">
<help><![CDATA[
Orders results according to your specifications.
]]></help>
<values/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
Username required for entry into database from which report
is created. Overrides default settings for data source in
CFML Administrator.
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Password that corresponds to username required for database
access. Overrides default settings for data source in
CFML Administrator.
]]></help>
<values/>
</parameter>
<parameter name="formula" required="false" type="String">
<help><![CDATA[
One or more named formulas. Terminate each formula with a
semicolon. Use the format:
formula = "formulaname1='formula1';formulaname2='formula2';"
If you use a semicolon in a formula, you must escape it by
typing it twice (;;). For example:
formula = "Name1 = 'Val_1a;;Val_1b';Name2 = 'Val2';"
]]></help>
<values/>
</parameter>
<parameter name="resourceTimespan" required="false" type="Variablename">
<help><![CDATA[
Life span of the resource directory. Used only with format=HTML
]]></help>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
Style in CSS format that overrides a style defined in the Report Builder report at run time.
]]></help>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfreportparam
name = "data name"
value = "data value"
-->
<tag endtagrequired="false" name="cfreportparam" single="true"
xmlstyle="false">
<help><![CDATA[
Passes input parameters to a ColdFusion Report Builder
report definition. Allowed inside cfreport tag bodies only.
]]></help>
<parameter name="name" required="false" type="String">
<help><![CDATA[
Variable name for data that is passed. The ColdFusion
Report Builder report definition must include an input
parameter that matches this name.
]]></help>
<values/>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
Value of the data that is sent.
]]></help>
<values/>
</parameter>
<parameter name="chart" required="false" type="String">
<help><![CDATA[
Name of the chart contained in a report or subreport. The value of this attribute must match Name property of a chart defined in the Report Builder report.
]]></help>
</parameter>
<parameter name="query" required="false" type="query">
<help><![CDATA[
Query value to pass to a subreport or chart. The ColdFusion query must contain at least all of the columns included in the Report Builder query.
]]></help>
</parameter>
<parameter name="series" required="false" type="Numeric">
<help><![CDATA[
Ordinal number of a chart series to use for the query. This attribute is valid only when the chart attribute is specified.
]]></help>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
Style in CSS format for a subreport.
]]></help>
</parameter>
<parameter name="subreport" required="false" type="String">
<help><![CDATA[
Name of the subreport.
]]></help>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfrethrow
-->
<tag endtagrequired="false" canHaveAttributeCollection="false" name="cfrethrow" single="true"
xmlstyle="false">
<help><![CDATA[
Rethrows the currently active exception. Preserves the
exception's cfcatch.type and cfcatch.tagContext variable
values.
]]></help>
</tag>
<!--
cfreturn
expr
-->
<tag endtagrequired="false" canHaveAttributeCollection="false" name="cfreturn" single="true"
xmlstyle="false">
<help><![CDATA[
Returns result values from a component method. Contains an
expression returned as result of the function.
An expression; the result of the function from which this tag
is called.
]]></help>
</tag>
<!--
cfsavecontent
variable = "variable name"
[the content]
/cfsavecontent
-->
<tag endtagrequired="true" name="cfsavecontent" single="false"
xmlstyle="true">
<help><![CDATA[
Saves the generated content of the cfsavecontent tag, including
the results of evaluating expressions and executing custom tags,
in the specified variable.
]]></help>
<return parameter="variable" type="variablename"/>
<parameter name="variable" required="true" returnVarType="variablename" type="String">
<help><![CDATA[
Name ofthe variable in which to save the generated content
of the tag.
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="variable">
<required>variable</required>
<optional/>
</combination>
</possiblecombinations>
</tag>
<tag endtagrequired="false" name="cfschedule" single="true"
xmlstyle="false">
<help><![CDATA[
Provides a programmatic interface to the CFML scheduling
engine. Can run a CFML page at scheduled intervals, with the
option to write the page output to a static HTML page. This
feature enables you to schedule pages that publish data, such
as reports, without waiting while a database transaction is
performed to populate the page.
]]></help>
<parameter isswitchattribute="true" name="action"
required="true" type="String">
<help><![CDATA[
delete: deletes the specified task
update: updates an existing task or creates a new task,
if one with the name specified by the task attribute
does not exist
run: executes the specified task
]]></help>
<values>
<value option="delete"/>
<value option="update"/>
<value option="run"/>
<value option="pause"/>
<value option="resume"/>
</values>
</parameter>
<parameter name="task" required="true" type="String">
<help><![CDATA[
Name of the task.
]]></help>
<values/>
</parameter>
<parameter name="operation" required="false" type="String">
<help><![CDATA[
Operation that the scheduler performs. Must be HTTPRequest.
]]></help>
<values/>
</parameter>
<parameter name="file" required="false" type="String">
<help><![CDATA[
Name of the file in which to store the published output of
the scheuled task
]]></help>
<values/>
</parameter>
<parameter name="path" required="false" type="String">
<help><![CDATA[
Path to the directory in which to put the published file.
]]></help>
<values/>
</parameter>
<parameter name="startdate" required="false" type="String">
<help><![CDATA[
Date on which to first run the scheuled task.
]]></help>
<values/>
</parameter>
<parameter name="starttime" required="false" type="String">
<help><![CDATA[
Time at which to run the scheduled of task starts.
]]></help>
<values/>
</parameter>
<parameter name="URL" required="false" type="URL">
<help><![CDATA[
URL of the page to execute.
]]></help>
<values/>
</parameter>
<parameter name="port" required="false" type="Numeric">
<help><![CDATA[
Port to use on the server that is specified by the url
parameter. If resolveURL = "yes", retrieved document URLs
that specify a port number are automatically resolved, to
preserve links in the retrieved document. A port value in
the url attribute overrides this value.
]]></help>
<values default="80"/>
</parameter>
<parameter name="publish" required="false" type="boolean">
<help><![CDATA[
Yes: save the result to a file
No: does not
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="endDate" required="false" type="String">
<help><![CDATA[
Date when scheduled task ends.
]]></help>
<values/>
</parameter>
<parameter name="endTime" required="false" type="Numeric">
<help><![CDATA[
Time when scheduled task ends (seconds).
]]></help>
<values/>
</parameter>
<parameter name="interval" required="false" type="String">
<help><![CDATA[
Interval at which task is scheduled.
* number of seconds (minimum is 60)
* once
* daily
* weekly
* monthly
]]></help>
<values>
<value option="once"/>
<value option="daily"/>
<value option="weekly"/>
<value option="monthly"/>
</values>
</parameter>
<parameter name="requesttimeout" required="false" type="Numeric">
<help><![CDATA[
Can be used to extend the default timeout period.
]]></help>
<values/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
Username, if URL is protected.
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Password, if URL is protected.
]]></help>
<values/>
</parameter>
<parameter name="proxyserver" required="false" type="String">
<help><![CDATA[
Host name or IP address of a proxy server.
]]></help>
<values/>
</parameter>
<parameter name="proxyport" required="false" type="Numeric">
<help><![CDATA[
Port number to use on the proxy server.
]]></help>
<values default="80"/>
</parameter>
<parameter name="proxyuser" required="false" type="String">
<help><![CDATA[
User name to provide to the proxy server.
]]></help>
<values/>
</parameter>
<parameter name="proxypassword" required="false" type="String">
<help><![CDATA[
Password to provide to the proxy server.
]]></help>
<values/>
</parameter>
<parameter name="resolveurl" required="false" type="boolean">
<help><![CDATA[
Yes: resolve links in the output page to absolute
references
No: does not
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="update">
<required>interval,operation,startdate,starttime,task,url</required>
<optional>enddate,endtime,file,password,path,port,proxypassword,proxyport,proxyserver,proxyuser,publish,requesttimeout,resolveurl,username</optional>
</combination>
<combination switchvalue="pause">
<required>task</required>
<optional/>
</combination>
<combination switchvalue="run">
<required>task</required>
<optional/>
</combination>
<combination switchvalue="delete">
<required>task</required>
<optional/>
</combination>
<combination switchvalue="resume">
<required>task</required>
<optional/>
</combination>
</possiblecombinations>
</tag>
<!--
cfscript
[cfscript code here]
/cfscript
-->
<tag endtagrequired="true" canHaveAttributeCollection="false" name="cfscript" single="false"
xmlstyle="false">
<help><![CDATA[
Encloses a code block that contains cfscript statements.
You cannot use some CFML 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,CFML,CFML_,_CFML
]]></help>
</tag>
<!--
cfsearch
name = "search_name"
collection = "collection_name"
category = "category[,category2,...]"
categoryTree = "tree_location"
status = ""
type = "criteria"
criteria = "search_expression"
maxRows = "number"
startRow = "row_number"
suggestions = "suggestion_option"
contextPassages = "number_of_passages"
contextBytes = "number_of_bytes"
contextHighlightBegin = "html_string"
contextHighlightEnd = "html_string"
previousCriteria = "criteria"
language = "language"
-->
<tag endtagrequired="false" name="cfsearch" single="true"
xmlstyle="false">
<help><![CDATA[
Searches Verity collections using CFML or K2Server,
whichever search engine a collection is registered by.
(CFML can also search collections that have not been
registered, with the cfcollection tag.)
A collection must be created and indexed before this tag can
return search results.
]]></help>
<return parameter="name" type="query"/>
<parameter name="name" required="true" returnVarType="query" type="String">
<help><![CDATA[
Name of the search query.
]]></help>
<values/>
</parameter>
<parameter name="collection" required="true" type="String">
<help><![CDATA[
One or more collection names. You can specify more
than one collection unless you are performing a
category search (that is, specifying category or
categoryTree).
One or more collection names. You can specify more
than one collection unless you are performing a
category search (that is, specifying category or
categoryTree).
]]></help>
<values/>
</parameter>
<parameter name="category" required="false" type="String">
<help><![CDATA[
A list of categories, separated by commas, to which
the search is limited. If specified, and the collection
does not have categories enabled, ColdFusion
throws an exception.
]]></help>
<values/>
</parameter>
<parameter name="categorytree" required="false" type="String">
<help><![CDATA[
The location in a hierarchical category tree at which
to start the search. ColdFusion searches at and
below this level. If specified, and the collection does
not have categories enabled, ColdFusion throws an
exception. Can be used in addition to category
attribute.
]]></help>
<values/>
</parameter>
<parameter name="status" required="false" type="String">
<help><![CDATA[
Specifies the name of the structure variable into
which ColdFusion places search information, including
alternative criteria suggestions (spelling corrections).
]]></help>
<values/>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
Used to specify the parser that Verity/SOLR uses to process
the criteria.
]]></help>
<values default="simple">
<value option="simple"/>
<value option="explicit"/>
<value option="internet"/>
<value option="internet_basic"/>
<value option="natural"/>
<value option="standard"/>
<value option="dismax"/>
</values>
</parameter>
<parameter name="criteria" required="false" type="String">
<help><![CDATA[
Search criteria. Follows the syntax rules of the type
attribute. If you pass a mixed-case entry in this attribute,
the search is case-sensitive. If you pass all uppercase or
all lowercase, the search is case-insensitive. Follow
Verity syntax and delimiter character rules; see Using
Verity Search Expressions in Developing CFML MX
Applications.
]]></help>
<values/>
</parameter>
<parameter name="maxrows" required="false" type="Numeric">
<help><![CDATA[
Maximum number of rows to return in query results.
Default: all
]]></help>
<values default="all"/>
</parameter>
<parameter name="startrow" required="false" type="Numeric">
<help><![CDATA[
First row number to get.
Default: 1
]]></help>
<values default="1"/>
</parameter>
<parameter name="suggestions" required="false" type="String">
<help><![CDATA[
Specifies whether Verity/SOLR returns spelling suggestions
for possibly misspelled words.
]]></help>
<values default="never">
<value option="always"/>
<value option="never"/>
<value option="5"/>
<value option="10"/>
</values>
</parameter>
<parameter name="contextPassages" required="false" type="Numeric">
<help><![CDATA[
The number of passages/sentences Verity returns in
the context summary (that is, the context column of
the results).
Default: 3
]]></help>
<values default="3"/>
</parameter>
<parameter name="contextBytes" required="false" type="Numeric">
<help><![CDATA[
The maximum number of bytes Verity returns in the
context summary.
Default: 300
]]></help>
<values default="300"/>
</parameter>
<parameter name="contextHighlightBegin" required="false" type="String">
<help><![CDATA[
The HTML to prepend to search terms in the context
summary. Use this attribute in conjunction with
contextHighlightEnd to highlight search terms in the
context summary.
Default: <b>
]]></help>
<values default="<b>">
<value option="<b>"/>
<value option="<strong>"/>
<value option="<span class="highlight">"/>
</values>
</parameter>
<parameter name="contextHighlightEnd" required="false" type="String">
<help><![CDATA[
The HTML to prepend to search terms in the context
summary. Use this attribute in conjunction with
contextHighlightEnd to highlight search terms in the
context summary.
Default: </b>
]]></help>
<values default="</b>">
<value option="</b>"/>
<value option="</strong>"/>
<value option="</span>"/>
</values>
</parameter>
<parameter name="previousCriteria" required="false" type="String">
<help><![CDATA[
The name of a result set from an existing set of search
results. Verity searches the result set for criteria
without regard to the previous search score or rank.
Use this attribute to implement searching within result
sets.
]]></help>
<values/>
</parameter>
<parameter deprecated="true" name="language"
required="false" type="String">
<help><![CDATA[
Deprecated. This attribute is now ignored and the language of the collection is used to perform the search.
]]></help>
</parameter>
<possiblecombinations>
<combination attributename="collection">
<required>collection,name</required>
<optional>category,categorytree,contextbytes,contexthighlightbegin,contexthighlightend,contextpassages,criteria,external,language,maxrows,previouscriteria,startrow,status,suggestions,type</optional>
</combination>
<combination attributename="name">
<required>collection,name</required>
<optional>category,categorytree,contextbytes,contexthighlightbegin,contexthighlightend,contextpassages,criteria,external,language,maxrows,previouscriteria,startrow,status,suggestions,type</optional>
</combination>
</possiblecombinations>
</tag>
<tag endtagrequired="true" name="cfselect" single="false"
xmlstyle="true">
<help><![CDATA[
Constructs a drop-down list box form control. Used within a
cfform tag.
You can populate the list from a query, or by using the HTML
option tag.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Name of the select form element
]]></help>
<values/>
</parameter>
<parameter name="id" required="false" type="String">
<help><![CDATA[
ID for form input element.
]]></help>
<values/>
</parameter>
<parameter name="bind" required="false" type="String">
<help><![CDATA[
A bind expression that dynamically sets an attribute
of the control.
]]></help>
<values/>
</parameter>
<parameter name="bindAttribute" required="false" type="String">
<help><![CDATA[
Specifies the HTML tag attribute whose value is set
by the bind attribute. You can only specify attributes
in the browser’s HTML DOM tree, not ColdFusion-
specific attributes.
Ignored if there is no bind attribute.
]]></help>
<values/>
</parameter>
<parameter name="bindOnLoad" required="false" type="boolean">
<help><![CDATA[
A Boolean value that specifies whether to execute
the bind attribute expression when first loading the
form. Ignored if there is no bind attribute.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="editable" required="false" type="boolean">
<help><![CDATA[
Boolean value specifying whether you can edit the
contents of the control.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="label" required="false" type="String">
<help><![CDATA[
Label to put next to the control on a Flash or XML-format form.
]]></help>
<values/>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
In HTML or XML format forms, ColdFusion passes the
style attribute to the browser or XML.
In Flash format, must be a style specification in CSS
format, with the same syntax and contents as used in
Macromedia Flex for the corresponding Flash element.
Post alpha we will document specifics.
]]></help>
<values/>
</parameter>
<parameter name="sourceForTooltip" required="false" type="String">
<help><![CDATA[
The URL of a page to display as a tool tip. The page
can include CFML and HTML markup to control the
tip contents and format, and the tip can include
images.
If you specify this attribute, an animated icon
appears with the text "Loading..." while the tip is
being loaded.
]]></help>
<values/>
</parameter>
<parameter name="size" required="false" type="Numeric">
<help><![CDATA[
Number of entries to display at one time. The default, 1,
displays a drop-down list. Any other value displays a list
box with size number of entries visible at one time.
]]></help>
<values default="1"/>
</parameter>
<parameter name="required" required="false" type="boolean">
<help><![CDATA[
If true a list element must be selected when form is submitted.
Note: This attribute has no effect if you omit the size
attribute or set it to 1 because the browser always submits
the displayed item. You can work around this issue format
forms by having an initial option tag with value=" " (note the
space character between the quotation marks).
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="message" required="false" type="String">
<help><![CDATA[
Message to display if required="true" and no selection is made.
]]></help>
<values/>
</parameter>
<parameter name="onerror" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to execute if validation fails.
]]></help>
<values/>
</parameter>
<parameter name="multiple" required="false" type="boolean">
<help><![CDATA[
- true: allow selecting multiple elements in drop-down list
- false: don't allow selecting multiple elements
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="query" required="false" type="String">
<help><![CDATA[
Name of query to populate drop-down list.
]]></help>
<values/>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
Query column to use for the value of each list element.
Used with query attribute.
]]></help>
<values/>
</parameter>
<parameter name="display" required="false" type="String">
<help><![CDATA[
Query column to use for the display label of each list
element. Used with query attribute.
]]></help>
<values/>
</parameter>
<parameter name="group" required="false" type="String">
<help><![CDATA[
Query column to use to group the items in the drop-down
list into a two-level hierarchical list..
]]></help>
<values/>
</parameter>
<parameter name="queryposition" required="false" type="String">
<help><![CDATA[
If you populate the options list with a query and use HTML
option child tags to specify additional entries, determines
the location of the items from the query relative to the items
from the option tags:
- above: Put the query items above the options items.
- below: Put the query items below the options items.
Default: above
]]></help>
<values default="above">
<value option="above"/>
<value option="below"/>
</values>
</parameter>
<parameter name="selected" required="false" type="String">
<help><![CDATA[
One or more option values to preselect in the selection list.
To specify multiple values, use a comma-delimited list. This
attribute applies only if selection list items are generated
from a query. The cfform preservedata attribute value can
override this value.
]]></help>
<values/>
</parameter>
<parameter name="onkeyup" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash) to run
when the user releases a keyboard key in the control.
]]></help>
<values/>
</parameter>
<parameter name="onkeydown" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash)
ActionScript to run when the user depresses a keyboard
key in the control.
]]></help>
<values/>
</parameter>
<parameter name="onmouseup" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash) to run
when the user presses a mouse button in the control.
]]></help>
<values/>
</parameter>
<parameter name="onmousedown" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash) to run
when the user releases a mouse button in the control.
]]></help>
<values/>
</parameter>
<parameter name="onchange" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash) to run
when the control changes due to user action.
]]></help>
<values/>
</parameter>
<parameter name="onclick" required="false" type="String">
<help><![CDATA[
JavaScript to run when the user clicks the control.
]]></help>
<values/>
</parameter>
<parameter name="enabled" required="false" type="boolean">
<help><![CDATA[
Flash only: Boolean value specifying whether to show the control.
Space that would be occupied by an invisible control is
blank.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="visible" required="false" type="boolean">
<help><![CDATA[
Flash only: Boolean value specifying whether to show the control.
Space that would be occupied by an invisible control is
blank.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="tooltip" required="false" type="String">
<help><![CDATA[
Flash only: Text to display when the mouse pointer hovers over the control.
]]></help>
<values/>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
The height of the control, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
The width of the control, in pixels.
]]></help>
<values/>
</parameter>
<parameter deprecated="true" name="passthrough"
required="false" type="String">
<help><![CDATA[
This attribute is deprecated.
Passes arbitrary attribute-value pairs to the HTML code
that is generated for the tag. You can use either of the
following formats:
passthrough="title=""myTitle"""
passthrough='title="mytitle"'
]]></help>
<values/>
</parameter>
<parameter name="onbinderror" required="false" type="String">
<help><![CDATA[
The name of a JavaScript function to execute if evaluating a bind expression results in an error. The function must take two attributes: an HTTP status code and a message.
]]></help>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>bind,bindattribute,bindonload,class,display,group,id,message,multiple,onbinderror,onblur,onchange,onclick,ondblclick,onerror,onfocus,passthrough,query,required,selected,size,sourcefortooltip,style,tabindex,tooltip,value</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfset
var variable_name = expression
-->
<tag allowanyattribute="true" canHaveAttributeCollection="false" endtagrequired="false"
name="cfset" single="true"
xmlstyle="false">
<help><![CDATA[
Sets a value in CFML. Used to create a variable, if it
does not exist, and assign it a value. Also used to call
functions.
]]></help>
</tag>
<!--
cfsetting
enableCFoutputOnly = "boolean"
showDebugOutput = "boolean"
requestTimeOut = "value in seconds"
-->
<tag endtagrequired="false" hybrid="true" name="cfsetting"
single="true"
xmlstyle="false">
<help><![CDATA[
Controls aspects of page processing, such as the output of
HTML code in pages.
]]></help>
<parameter name="enablecfoutputonly" required="false" type="boolean">
<help><![CDATA[
Yes: blocks output of HTML that is outside cfoutput tags
No: displays HTML that is outside cfoutput tags.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="showdebugoutput" required="false" type="boolean">
<help><![CDATA[
Yes: If debugging is enabled in the Administrator, displays
debugging information
No: suppresses debugging information that would otherwise
display at end of generated page.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="requesttimeout" required="false" type="Numeric">
<help><![CDATA[
Integer; number of seconds. Time limit, after which
CFML processes the page as an unresponsive thread.
Overrides the timeout set in the CFML Administrator.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfsilent
...
/cfsilent
-->
<tag endtagrequired="false" name="cfsilent" single="false"
xmlstyle="true">
<help><![CDATA[
Suppresses output produced by CFML within a tag's scope.
]]></help>
<possiblecombinations/>
</tag>
<!--
cfslider
name = "name"
label = "text"
range = "min_value, max_value"
scale = "uinteger"
value = "integer"
onValidate = "script_name"
message = "text"
onError = "text"
height = "integer"
width = "integer"
vSpace = "integer"
hSpace = "integer"
align = "alignment"
lookAndFeel = "motif" or "windows" or "metal"
vertical = "boolean"
bgColor = "color"
textColor = "color"
font = "font_name"
fontSize = "integer"
italic = "boolean"
bold = "boolean"
notSupported = "text"
-->
<tag endtagrequired="false" name="cfslider" single="true"
xmlstyle="false">
<help><![CDATA[
Puts a slider control, for selecting a numeric value from a
range, in a ColdFusion form. The slider moves over the slider
groove. As the user moves the slider, the current value
displays. Used within a cfform tag.
Not supported with Flash forms.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Name for cfslider control.
]]></help>
<values/>
</parameter>
<parameter name="label" required="false" type="String">
<help><![CDATA[
Label to display with control.
For example, "Volume" This displays: "Volume %value%"
To reference the value, use "%value%". If %% is omitted,
slider value displays directly after label.
]]></help>
<values/>
</parameter>
<parameter name="range" required="false" type="String">
<help><![CDATA[
Numeric slider range values.
Separate values with a comma.
]]></help>
<values default="0,100"/>
</parameter>
<parameter name="scale" required="false" type="Numeric">
<help><![CDATA[
Unsigned integer. Defines slider scale, within range.
For example: if range = "0,1000" and scale = "100",
the display values are: 0, 100, 200, 300, ...
Signed and unsigned integers in ColdFusion are in the
range -2,147,483,648 to 2,147,483,647.
]]></help>
<values/>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
Starting slider setting. Must be within the range values.
]]></help>
<values/>
</parameter>
<parameter name="onvalidate" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to validate user input; in this
case, a change to the default slider value. Specify only
the function name.
]]></help>
<values/>
</parameter>
<parameter name="message" required="false" type="String">
<help><![CDATA[
Message text to appear if validation fails.
]]></help>
<values/>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
Slider control height, in pixels.
]]></help>
<values default="40"/>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Slider control width, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="vspace" required="false" type="Numeric">
<help><![CDATA[
Vertical spacing above and below slider, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="hspace" required="false" type="Numeric">
<help><![CDATA[
Horizontal spacing to left and right of slider, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="align" required="false" type="String">
<help><![CDATA[
Alignment of slider:
* top
* left
* bottom
* baseline
* texttop
* absbottom
* middle
* absmiddle
* right
]]></help>
<values>
<value option="top"/>
<value option="left"/>
<value option="bottom"/>
<value option="baseline"/>
<value option="texttop"/>
<value option="absbottom"/>
<value option="middle"/>
<value option="absmiddle"/>
<value option="right"/>
</values>
</parameter>
<parameter name="lookandfeel" required="false" type="String">
<help><![CDATA[
- motif: renders slider in Motif style
- windows: renders slider in Windows style
- metal: renders slider in Java Swing style
If platform does not support style option, tag defaults to
platform default style.
Default: windows
]]></help>
<values default="windows">
<value option="motif"/>
<value option="windows"/>
<value option="metal"/>
</values>
</parameter>
<parameter name="vertical" required="false" type="boolean">
<help><![CDATA[
Yes: Renders slider in browser vertically. You must set
width and height attributes; ColdFusion does not
automatically swap width and height values.
No: Renders slider horizontally.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="bgcolor" required="false" type="String">
<help><![CDATA[
Background color of control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values>
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="gray"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="textcolor" required="false" type="String">
<help><![CDATA[
Text color for control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values>
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="gray"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="font" required="false" type="String">
<help><![CDATA[
Font name for data in tree control.
]]></help>
<values default="arial">
<value option="arial"/>
<value option="times"/>
<value option="courier"/>
<value option="arialunicodeMS"/>
</values>
</parameter>
<parameter name="fontsize" required="false" type="Numeric">
<help><![CDATA[
Font size for text in tree control, in points.
]]></help>
<values/>
</parameter>
<parameter name="italic" required="false" type="boolean">
<help><![CDATA[
Yes: displays tree control text in italics
No: it does not
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="bold" required="false" type="boolean">
<help><![CDATA[
Yes: displays tree control text in bold
No: it does not
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="notsupported" required="false" type="String">
<help><![CDATA[
Text to display if a page that contains a Java applet-based
cfform control is opened by a browser that does not
support Java or has Java support disabled.
Default:
"<b>Browser must support Java to <br>view ColdFusion Java
Applets!</b>"
]]></help>
<values default="<b>Browser must support Java to <br>view ColdFusion Java Applets!</b>"/>
</parameter>
<parameter name="clickToChange" required="false" type="Boolean">
<help><![CDATA[
Whether clicking the slider changes the value of the pointer:
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="max" required="false" type="Numeric">
<help><![CDATA[
Maximum value for the slider.
]]></help>
</parameter>
<parameter name="onChange" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to run when slider value changes.
Specify only the function name.
]]></help>
</parameter>
<parameter name="min" required="false" type="Numeric">
<help><![CDATA[
Minimum value for the slider.
]]></help>
</parameter>
<parameter name="onDrag" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to run when you drag the slider.
Specify only the function name.
]]></help>
</parameter>
<parameter name="onError" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to run if validation fails.
Specify only the function name.
]]></help>
</parameter>
<parameter name="increment" required="false" type="String">
<help><![CDATA[
The unit increment value for a snapping slider.
]]></help>
</parameter>
<parameter name="tip" required="false" type="Boolean">
<help><![CDATA[
Whether the data valu has to display as data tips
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="format" required="false" type="String">
<help><![CDATA[
Specifies if the format is:html/applet
]]></help>
<values>
<value option="html" />
<value option="applet" />
</values>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>align,bgcolor,bold,font,fontsize,groovecolor,height,hspace,img,imgstyle,italic,label,lookandfeel,message,notsupported,onerror,onvalidate,range,refreshlabel,scale,textcolor,tickmarkimages,tickmarklabels,tickmarkmajor,tickmarkminor,value,vertical,vspace,width</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfstoredproc
procedure = "procedure name"
dataSource = "ds_name"
username = "username"
password = "password"
blockFactor = "blocksize"
debug = "boolean"
returnCode = "boolean"
result = "result_name"
-->
<tag endtagrequired="false" name="cfstoredproc" single="false"
xmlstyle="false">
<help><![CDATA[
Executes a stored procedure in a server database. It
specifies database connection information and identifies
the stored procedure.
]]></help>
<return parameter="result" type="query"/>
<parameter name="procedure" required="true" type="String">
<help><![CDATA[
Name of stored procedure on database server.
]]></help>
<values/>
</parameter>
<parameter name="datasource" required="true" type="String">
<help><![CDATA[
Name of data source that points to database that contains
stored procedure.
]]></help>
<values/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
Overrides username in data source setup.
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Overrides password in data source setup.
]]></help>
<values/>
</parameter>
<parameter name="blockfactor" required="false" type="Numeric">
<help><![CDATA[
Maximum number of rows to get at a time from server.
Range is 1 to 100.
]]></help>
<values/>
</parameter>
<parameter name="debug" required="false" type="boolean">
<help><![CDATA[
Yes: Lists debug information on each statement
No: does not
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="returncode" required="false" type="boolean">
<help><![CDATA[
Yes: Tag populates cfstoredproc.statusCode with status
code returned by stored procedure.
No: does not
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="result" required="false" type="variableName">
<help><![CDATA[
Specifies a name for the structure in which cfstoredproc
returns the statusCode and ExecutionTime variables. If
set, this value replaces cfstoredproc as the prefix to
use when accessing those variables.
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="procedure">
<required>procedure</required>
<optional>blockfactor,datasource,debug,password,result,returncode,username</optional>
</combination>
<combination attributename="procedure">
<required>datasource,procedure</required>
<optional>blockfactor,debug,password,result,returncode,username</optional>
</combination>
<combination attributename="procedure">
<required>procedure</required>
<optional>blockfactor,datasource,debug,password,result,returncode,username</optional>
</combination>
<combination attributename="procedure">
<required>datasource,procedure</required>
<optional>blockfactor,debug,password,result,returncode,username</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfswitch
expression = "expression"
[one or more cfcase tags
zero or one cfdefaultcase tags]
/cfswitch
-->
<tag endtagrequired="true" canHaveAttributeCollection="false" name="cfswitch" single="false"
xmlstyle="true">
<help><![CDATA[
Evaluates a passed expression and passes control to the cfcase
tag that matches the expression result. You can, optionally,
code a cfdefaultcase tag, which receives control if there is no
matching cfcase tag value.
]]></help>
<parameter name="expression" required="true" type="String">
<help><![CDATA[
CFML expression that yields a scalar value.
CFML converts integers, real numbers, Booleans, and
dates to numeric values. For example, True, 1, and 1.0 are
all equal.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cftable
query = "query_name"
maxRows = "maxrows_table"
colSpacing = "number_of_spaces"
headerLines = "number_of_lines"
HTMLTable
border
colHeaders
startRow = "row_number">
/cftable
-->
<tag endtagrequired="true" name="cftable" single="false"
xmlstyle="false">
<help><![CDATA[
Builds a table in a CFML page. This tag renders data as
preformatted text, or, with the HTMLTable attribute, in an
HTML table. If you do not want to write HTML table tag code, or
if your data can be presented as preformatted text, use this
tag.
Preformatted text (defined in HTML with the <pre> and </pre>
tags) displays text in a fixed-width font. It displays white
space and line breaks exactly as they are written within the
pre tags. For more information, see an HTML reference guide.
To define table column and row characteristics, use the cfcol
tag within this tag.
]]></help>
<parameter name="query" required="true" type="query">
<help><![CDATA[
Name of cfquery from which to draw data.
]]></help>
<values/>
</parameter>
<parameter name="maxrows" required="false" type="Numeric">
<help><![CDATA[
Maximum number of rows to display in the table.
]]></help>
<values/>
</parameter>
<parameter name="colSpacing" required="false" type="Numeric">
<help><![CDATA[
Number of spaces between columns
]]></help>
<values/>
</parameter>
<parameter name="headerLines" required="false" type="Numeric">
<help><![CDATA[
Number of lines to use for table header (the default leaves
one line between header and first row of table).
]]></help>
<values/>
</parameter>
<parameter name="htmltable" required="false" type="Any">
<help><![CDATA[
Renders data in an HTML 3.0 table.
If you use this attribute (regardless of its value),
CFML renders data in an HTML table.
]]></help>
<values/>
</parameter>
<parameter name="border" required="false" type="Any">
<help><![CDATA[
Displays border around table.
If you use this attribute (regardless of its value),
CFML displays a border around the table.
Use this only if you use the HTMLTable attribute.
]]></help>
<values/>
</parameter>
<parameter name="colheaders" required="false" type="Any">
<help><![CDATA[
Displays column heads. If you use this attribute, you must
also use the cfcol tag header attribute to define them.
If you use this attribute (regardless of its value),
CFML displays column heads.
]]></help>
<values/>
</parameter>
<parameter name="startrow" required="false" type="Numeric">
<help><![CDATA[
The query result row to put in the first table row.
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="query">
<required>query</required>
<optional>border,colheaders,colspacing,headerlines,htmltable,maxrows,startrow</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cftextarea
name = "name"
label = "text"
required = "boolean"
style = "style specification"
validate = "data type"
validateAt= one or more of "onBlur", "onServer", "onSubmit"
message = "text"
range = "min_value, max_value"
maxlength = "number"
pattern = "regexp"
onValidate = "script name"
onError = "script name"
disabled = "true, false, or no attribute value"
value = "text"
onKeyUp = "JavaScript or ActionScript"
onKeyDown = "JavaScript or ActionScript"
onMouseUp = "JavaScript or ActionScript"
onMouseDown = "JavaScript or ActionScript"
onChange = "JavaScript or ActionScript"
onClick = "JavaScript or ActionScript"
visible = "boolean"
enabled = "boolean"
tooltip = "Tip text"
height = "number of pixels" Flash only
width = "number of pixels" Flash only
text
/cftextarea
-->
<tag endtagrequired="true" name="cftextarea" single="false"
xmlstyle="true">
<help><![CDATA[
Puts a multiline text entry box in a cfform tag and
controls its display characteristics.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Name of the cftextinput control.
]]></help>
<values/>
</parameter>
<parameter name="label" required="false" type="String">
<help><![CDATA[
Label to put beside the control on a form.
]]></help>
<values/>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
In HTML or XML format forms, ColdFusion passes the
style attribute to the browser or XML.
In Flash format forms, must be a style specification in
CSS format, with the same syntax and contents as used
in Macromedia Flex for the corresponding Flash element.
]]></help>
<values/>
</parameter>
<parameter name="required" required="false" type="boolean">
<help><![CDATA[
- true: the field must contain text.
- false: the field can be empty.
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="html" required="false" type="boolean">
<help><![CDATA[
Boolean value that specifies whether the text area contains HTML.
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="validate" required="false" type="String">
<help><![CDATA[
The type or types of validation to do. Available validation
types and algorithms depend on the format. For details,
see the Usage section of the cfinput tag reference.
]]></help>
<values/>
</parameter>
<parameter name="validateat" required="false" type="String">
<help><![CDATA[
How to do the validation. For Flash format forms, onSubmit
and onBlur are identical; validation is done on submit.
For multiple values, use a comma-delimited list.
For details, see the Usage section of the cfinput tag
reference.
Default: onSubmit
]]></help>
<values default="onSubmit">
<value option="onSubmit"/>
<value option="onServer"/>
<value option="onBlur"/>
</values>
</parameter>
<parameter name="message" required="false" type="String">
<help><![CDATA[
Message text to display if validation fails.
]]></help>
<values/>
</parameter>
<parameter name="range" required="false" type="String">
<help><![CDATA[
Minimum and maximum numeric allowed values. ColdFusion
uses this attribute only if you specify range in the
validate attribute.
If you specify a single number or a single number a
followed by a comma, it is treated as a minimum, with no
maximum. If you specify a comma followed by a number,
the maximum is set to the specified number, with no
minimum.
]]></help>
<values/>
</parameter>
<parameter name="maxlength" required="false" type="Numeric">
<help><![CDATA[
The maximum length of text that can be entered.
ColdFusion uses this attribute only if you specify
maxlength in the validate attribute.
]]></help>
<values/>
</parameter>
<parameter name="pattern" required="false" type="String">
<help><![CDATA[
JavaScript regular expression pattern to validate input.
Omit leading and trailing slashes. ColdFusion uses this
attribute only if you specify regex in the validate attribute.
]]></help>
<values/>
</parameter>
<parameter name="onvalidate" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to validate user input. The
JavaScript DOM form object, input object, and input
object value are passed to routine, which should return
True if validation succeeds, False otherwise. If you specify
this attribute, ColdFusion ignores the validate attribute.
]]></help>
<values/>
</parameter>
<parameter name="onerror" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to execute if validation fails.
]]></help>
<values/>
</parameter>
<parameter name="disabled" required="false" type="boolean">
<help><![CDATA[
Disables user input, making the control read-only. To
disable input, specify disabled without an attribute, or
disabled="true". To enable input, omit the attribute or
specify disabled="false".
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
Initial value to display in text control. You can specify an
initial value as an attribute or in the tag body, but not in
both places. If you specify the value as an attribute, you
must put the closing cftextarea tag immediately after the
opening cftextarea tag, with no spaces or line feeds between,
or place a closing slash at the end of the opening cftextarea
tag. For example:
<cftextarea name="description" value="Enter a description." />
]]></help>
<values/>
</parameter>
<parameter name="bind" required="false" type="String">
<help><![CDATA[
Flash only: A Flex bind expression that populates the field with
information from other form fields.
]]></help>
<values/>
</parameter>
<parameter name="onkeyup" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash) to run
when the user releases a keyboard key in the control.
]]></help>
<values/>
</parameter>
<parameter name="onkeydown" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash)
ActionScript to run when the user presses a keyboard
key in the control.
]]></help>
<values/>
</parameter>
<parameter name="onmouseup" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash) to run
when the user presses a mouse button in the control.
]]></help>
<values/>
</parameter>
<parameter name="onmousedown" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash) to run
when the user releases a mouse button in the control.
]]></help>
<values/>
</parameter>
<parameter name="onchange" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) or ActionScript (Flash) to run
when the control changes due to user action.
]]></help>
<values/>
</parameter>
<parameter name="onclick" required="false" type="String">
<help><![CDATA[
JavaScript (HTML/XML) to run when the user clicks the
control. Not supported for Flash forms.
]]></help>
<values/>
</parameter>
<parameter name="enabled" required="false" type="boolean">
<help><![CDATA[
Flash only: Boolean value specifying whether the control is enabled.
A disabled control appears in light gray. The inverse of the
diabled attribute.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="visible" required="false" type="boolean">
<help><![CDATA[
Flash only: Boolean value specifying whether to
show the control. Space that would be occupied by an
invisible control is blank.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="tooltip" required="false" type="String">
<help><![CDATA[
Flash only: Text to display when the mouse pointer hovers
over the control.
]]></help>
<values/>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
Flash only: The height of the control, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Flash only: The width of the control, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="basepath" required="false" type="String">
<help><![CDATA[
Path to the directory that contains the rich text editor. The editor configuration files are at the top level of this directory.
]]></help>
</parameter>
<parameter name="bindattribute" required="false" type="String">
<help><![CDATA[
Specifies the HTML tag attribute whose value is set by the bind attribute. You can only specify attributes in the browser's HTML DOM tree, not ColdFusion-specific attributes.
]]></help>
</parameter>
<parameter name="bindonload" required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies whether to execute the bind attribute expression when first loading the form.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="fontformats" required="false" type="String">
<help><![CDATA[
A comma separated list of the font names to display in the rich text editor Formats selector. The formats specify the HTML tags to apply to typed or selected text.
]]></help>
</parameter>
<parameter name="fontnames" required="false" type="String">
<help><![CDATA[
A comma separated list of the font names to display in the rich text editor Font selector.
]]></help>
</parameter>
<parameter name="fontsizes" required="false" type="String">
<help><![CDATA[
A comma separated list of the font sizes to display in the rich text editor Size selector. List entries must have the format of numeric font size/descriptive text.
]]></help>
</parameter>
<parameter name="onbinderror" required="false" type="String">
<help><![CDATA[
The name of a JavaScript function to execute if evaluating a bind expression results in an error. The function must take two attributes: an HTTP status code and a message.
]]></help>
</parameter>
<parameter name="richtext" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether this control is a rich text editor with tool bars to control the text formatting.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="skin" required="false" type="String">
<help><![CDATA[
Specifies the skin to be used for the rich text editor. By default, the valid values are Default, silver, and office2003.
You can also create custom skins that you can then specify in this attribute.
]]></help>
<values default="default">
<value option="default"/>
<value option="silver"/>
<value option="office2003"/>
</values>
</parameter>
<parameter name="wrap" required="false" type="String">
<help><![CDATA[
* hard: wraps long lines, and sends the carriage return to the server.
* off: does not wrap long lines.
* physical: wraps long lines, and transmits the text at all wrap points.
* soft: wraps long lines, but does not send the carriage return to the server.
* virtual: wraps long lines, but does not send the carriage return to the server.
]]></help>
<values>
<value option="hard"/>
<value option="off"/>
<value option="physical"/>
<value option="virtual"/>
<value option="soft"/>
</values>
</parameter>
<parameter name="sourcefortooltip" required="false" type="String">
<help><![CDATA[
The URL of a page to display as a tool tip.
The page can include CFML and HTML to control the contents and format, and the tip can include images.
If you specify this attribute, an animated icon appears with the text "Loading..." while the tip is being loaded.
]]></help>
</parameter>
<parameter name="stylesxml" required="false" type="String">
<help><![CDATA[
The path of the file that defines the styles in the rich text editor Styles selector.
Relative paths start at the directory that contains the fckeditor.html file, normally cf_webRoot/CFIDE/scripts/ajax/FCKeditor/editor.
]]></help>
</parameter>
<parameter name="templatesxml" required="false" type="String">
<help><![CDATA[
The pathof the file that defines the templates that are displayed when you click the rich text editor Templates icon.
]]></help>
</parameter>
<parameter name="toolbar" required="false" type="String">
<help><![CDATA[
Specifies the rich text editor toolbar. By default, the valid values for this attribute are: Default, a complete set of controls, and Basic, a minimal configuration.
]]></help>
</parameter>
<parameter name="toolbaronfocus" required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies whether the rich text editor toolbar expands and displays its controls only when the rich text editor has the focus.
]]></help>
</parameter>
<parameter name="secureUpload" required="false" type="boolean">
<help><![CDATA[
If true, enables secure upload using FCKeditor.
For secure upload, you must have
sessionManagement set to yes. Secure upload does not work if sessionManagement is set to false.
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>basepath,bind,bindattribute,bindonload,fontformats,fontnames,fontsizes,height,maxlength,message,onbinderror,onerror,onvalidate,pattern,range,readonly,required,richtext,skin,sourcefortooltip,stylesxml,templatesxml,toolbar,toolbaronfocus,tooltip,type,validate,value,width</optional>
</combination>
</possiblecombinations>
</tag>
<tag compatibility="deprecated" deprecated="true"
endtagrequired="false" name="cftextinput" single="true"
xmlstyle="false">
<help><![CDATA[
This tag is deprecated.
Puts a single-line text entry box in a cfform tag and controls
its display characteristics.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Name for the cftextinput control.
]]></help>
<values/>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
Initial value to display in text control.
]]></help>
<values/>
</parameter>
<parameter name="required" required="false" type="boolean">
<help><![CDATA[
Yes: the user must enter or change text
No
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="range" required="false" type="String">
<help><![CDATA[
Minimum-maximum value range, delimited by a comma.
Valid only for numeric data.
]]></help>
<values/>
</parameter>
<parameter name="validate" required="false" type="String">
<help><![CDATA[
date: verifies format mm/dd/yy.
eurodate: verifies date format dd/mm/yyyy.
time: verifies time format hh:mm:ss.
float: verifies floating point format.
integer: verifies integer format.
telephone: verifies telephone format ###-###-####. The
separator can be a blank. Area code and exchange must
begin with digit 1 - 9.
zipcode: verifies, in U.S. formats only, 5- or 9-digit
format #####-####. The separator can be a blank.
creditcard: strips blanks and dashes; verifies number using
mod10 algorithm. Number must have 13-16 digits.
social_security_number: verifies format ###-##-####. The
separator can be a blank.
regular_expression: matches input against pattern
attribute.
]]></help>
<values>
<value option="date"/>
<value option="eurodate"/>
<value option="time"/>
<value option="float"/>
<value option="integer"/>
<value option="telephone"/>
<value option="zipcode"/>
<value option="creditcard"/>
<value option="social_security_number"/>
<value option="regular_expression"/>
</values>
</parameter>
<parameter name="onvalidate" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to validate user input. The form
object, input object, and input object value are passed to
routine, which should return True if validation succeeds,
False otherwise. The validate attribute is ignored.
]]></help>
<values/>
</parameter>
<parameter name="pattern" required="false" type="Regex">
<help><![CDATA[
JavaScript regular expression pattern to validate input.
Omit leading and trailing slashes
]]></help>
<values/>
</parameter>
<parameter name="message" required="false" type="String">
<help><![CDATA[
Message text to display if validation fails
]]></help>
<values/>
</parameter>
<parameter name="onerror" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to execute if validation fails.
]]></help>
<values/>
</parameter>
<parameter name="size" required="false" type="Numeric">
<help><![CDATA[
Number of characters displayed before horizontal scroll
bar displays.
]]></help>
<values/>
</parameter>
<parameter name="font" required="false" type="String">
<help><![CDATA[
Font name for data in tree control.
]]></help>
<values default="arial">
<value option="arial"/>
<value option="times"/>
<value option="courier"/>
<value option="arialunicodeMS"/>
</values>
</parameter>
<parameter name="fontsize" required="false" type="Numeric">
<help><![CDATA[
Font size for text in tree control, in points.
]]></help>
<values/>
</parameter>
<parameter name="italic" required="false" type="boolean">
<help><![CDATA[
Yes: displays tree control text in italics
No: it does not
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="bold" required="false" type="boolean">
<help><![CDATA[
Yes: displays tree control text in bold
No: it does not
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
Tree control height, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Tree control width, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="vspace" required="false" type="Numeric">
<help><![CDATA[
Vertical margin above and below tree control, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="hspace" required="false" type="Numeric">
<help><![CDATA[
Horizontal spacing to left and right of tree control, in pixels.
]]></help>
<values/>
</parameter>
<parameter name="align" required="false" type="String">
<help><![CDATA[
* top
* left
* bottom
* baseline
* texttop
* absbottom
* middle
* absmiddle
* right
]]></help>
<values>
<value option="top"/>
<value option="left"/>
<value option="bottom"/>
<value option="baseline"/>
<value option="texttop"/>
<value option="absbottom"/>
<value option="middle"/>
<value option="absmiddle"/>
<value option="right"/>
</values>
</parameter>
<parameter name="bgcolor" required="false" type="String">
<help><![CDATA[
Background color of control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values>
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="gray"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="textcolor" required="false" type="String">
<help><![CDATA[
Text color for control. For a hex value, use the form:
textColor = "##xxxxxx", where x = 0-9 or A-F; use two hash
signs or none.
]]></help>
<values>
<value option="black"/>
<value option="red"/>
<value option="blue"/>
<value option="magenta"/>
<value option="cyan"/>
<value option="orange"/>
<value option="darkgray"/>
<value option="pink"/>
<value option="gray"/>
<value option="white"/>
<value option="lightgray"/>
<value option="yellow"/>
</values>
</parameter>
<parameter name="maxlength" required="false" type="Numeric">
<help><![CDATA[
The maximum length of text entered.
]]></help>
<values/>
</parameter>
<parameter name="notsupported" required="false" type="String">
<help><![CDATA[
Text to display if a page that contains a Java applet-based
cfform control is opened by a browser that does not
support Java or has Java support disabled.
Default:
"<b>Browser must support Java to <br>view ColdFusion Java
Applets!</b>"
]]></help>
<values default="<b>Browser must support Java to <br>view ColdFusion Java Applets!</b>"/>
</parameter>
<parameter name="label" required="false" type="String">
<help><![CDATA[
Label for text input
]]></help>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>align,bgcolor,bold,font,fontsize,height,hspace,italic,label,maxlength,message,notsupported,onerror,onvalidate,pattern,range,required,size,textcolor,validate,value,vspace,width</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfthrow
type = "exception_type "
message = "message"
detail = "detail_description "
errorCode = "error_code "
extendedInfo = "additional_information"
object = "java_except_object"
-->
<tag endtagrequired="false" name="cfthrow" single="true"
xmlstyle="false">
<help><![CDATA[
Throws a developer-specified exception, which can be caught
with a cfcatch tag that has any of the following type attribute
options:
type = "custom_type"
type = "Application"
type = "Any"
]]></help>
<parameter name="type" required="false" type="String">
<help><![CDATA[
* A custom type
* Application
Do not enter another predefined type; types are not
generated by CFML applications. If you specify
Application, you need not specify a type for cfcatch.
]]></help>
<values default="Custom">
<value option="Custom"/>
<value option="Application"/>
<value option="Database"/>
<value option="Template"/>
<value option="Security"/>
<value option="Object"/>
<value option="MissingInclude"/>
<value option="Expression"/>
<value option="Lock"/>
<value option="SearchEngine"/>
</values>
</parameter>
<parameter name="message" required="false" type="String">
<help><![CDATA[
Message that describes exception event.
]]></help>
<values/>
</parameter>
<parameter name="detail" required="false" type="String">
<help><![CDATA[
Description of the event. CFML appends error position
to description; server uses this parameter if an error is
not caught by your code.
]]></help>
<values/>
</parameter>
<parameter name="errorcode" required="false" type="String">
<help><![CDATA[
A custom error code that you supply.
]]></help>
<values/>
</parameter>
<parameter name="extendedinfo" required="false" type="String">
<help><![CDATA[
A custom error code that you supply.
]]></help>
<values/>
</parameter>
<parameter name="object" required="false" type="Object">
<help><![CDATA[
Requires the value of the cfobject tag name attribute.
Throws a Java exception from a CFML tag.
This attribute is mutually exclusive with all other
attributes of this tag.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<!--
cftimer
label= "text"
type = "inline" or "outline" or "comment" or "debug"
CFML statement(s)
/cftimer
-->
<tag endtagrequired="true" name="cftimer" single="false"
xmlstyle="true">
<help><![CDATA[
Displays execution time for a specified section of
CFML code. ColdFusion MX displays the timing information
along with any output produced by the timed code.
]]></help>
<parameter name="label" required="false" type="String">
<help><![CDATA[
Label to display with timing information.
Default: " "
]]></help>
<values default=" "/>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
- inline: displays timing information inline, following the
resulting HTML.
- outline: displays timing information and also displays a line
around the output produced by the timed code. The browser
must support the FIELDSET tag to display the outline.
- comment: displays timing information in an HTML comment
in the format <!-- label: elapsed-time ms -->. The default label
is cftimer.
- debug: displays timing information in the debug output
under the heading CFTimer Times.
Default: debug
]]></help>
<values default="debug">
<value option="inline"/>
<value option="outline"/>
<value option="comment"/>
<value option="debug"/>
</values>
</parameter>
<possiblecombinations/>
</tag>
<tag endtagrequired="false" hybrid="true" name="cftrace"
single="true"
xmlstyle="false">
<help><![CDATA[
Displays and logs debugging data about the state of an
application at the time the cftrace tag executes. Tracks
runtime logic flow, variable values, and execution time.
Displays output at the end of the request or in the debugging
section at the end of the request;
CFML logs cftrace output to the file logs\cftrace.log, in
the CFML installation directory.
Note: To permit this tag to execute, you must enable debugging
in the CFML Administrator. Optionally, to report trace
summaries, enable the Trace section.
]]></help>
<parameter name="abort" required="false" type="boolean">
<help><![CDATA[
Calls cfabort tag when the tag is executed
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="category" required="false" type="String">
<help><![CDATA[
User-defined string for identifying trace groups
]]></help>
<values/>
</parameter>
<parameter name="inline" required="false" type="boolean">
<help><![CDATA[
Displays trace code in line on the page in the
location of the cftrace tag, addition to the debugging
information output.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="text" required="false" type="String">
<help><![CDATA[
User-defined string, which can include simple variable,
but not complex variables such as arrays. Outputs to cflog
text attribute
]]></help>
<values/>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
Corresponds to the cflog type attribute; displays an
appropriate icon.
* Information
* Warning
* Error
* Fatal Information
]]></help>
<values default="information">
<value option="information"/>
<value option="warning"/>
<value option="error"/>
<value option="fatal information"/>
</values>
</parameter>
<parameter name="var" required="false" type="String">
<help><![CDATA[
The name of a simple or complex variable to display.
Useful for displaying a temporary value, or a value that
does not display on any CFM page.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<tag endtagrequired="true" name="cftransaction" single="false"
xmlstyle="false">
<help><![CDATA[
Instructs the database management system to treat multiple
database operations as a single transaction. Provides database
commit and rollback processing.
]]></help>
<parameter isswitchattribute="true" name="action"
required="false" type="String">
<help><![CDATA[
<ul>
<li>begin: the start of the block of code to execute</li>
<li>commit: commits a pending transaction</li>
<li>rollback: rolls back a pending transaction</li>
</ul>
]]></help>
<values default="begin">
<value option="begin"/>
<value option="commit"/>
<value option="rollback"/>
<value option="setsavepoint"/>
</values>
</parameter>
<parameter name="isolation" required="false" type="String">
<help><![CDATA[
ODBC lock type.
]]></help>
<values>
<value option="read_uncommitted"/>
<value option="read_committed"/>
<value option="repeatable_read"/>
<value option="serializable"/>
</values>
</parameter>
<parameter name="savepoint" required="false" type="String">
<help><![CDATA[
The name of the savepoint in the transaction.
]]></help>
</parameter>
<parameter name="nested" required="false" type="Boolean">
<help><![CDATA[
specifies whether transaction is nested or not
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="setsavepoint">
<required>savepoint</required>
<optional>isolation</optional>
</combination>
<combination switchvalue="commit">
<required/>
<optional>isolation,savepoint</optional>
</combination>
<combination switchvalue="begin">
<required/>
<optional>action,isolation,savepoint,nested</optional>
</combination>
<combination switchvalue="rollback">
<required/>
<optional>isolation,savepoint</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cftree name = "name"
format="applet" "flash", xml, or "Object"
required = "boolean"
delimiter = "delimiter"
completePath = "boolean"
appendKey = "boolean"
highlightHref = "boolean"
onValidate = "script_name"
message = "text"
onError = "text"
lookAndFeel = "motif" or "windows" or "metal"
font = "font"
fontSize = "size"
italic = "boolean"
bold = "boolean"
height = "integer"
width = "integer"
vSpace = "integer"
hSpace = "integer"
align = "alignment"
border = "boolean"
hScroll = "boolean"
vScroll = "boolean"
style= "style specification"
enabled = "boolean"
visible = "boolean"
tooltip = "Tip text"
onChange = "ActionScript"
onBlur = "ActionScript"
onFocus = "ActionScript"
notSupported = "text"
...
/cftree
-->
<tag endtagrequired="true" name="cftree" single="false"
xmlstyle="true">
<help><![CDATA[
Inserts a tree control in a form. Validates user selections.
Used within a cftree tag block. You can use a CFML query
to supply data to the tree.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Name for tree control.
]]></help>
<values/>
</parameter>
<parameter name="format" required="false" type="String">
<help><![CDATA[
- applet: displays the tree using a Java applet in the
browser,
- flash: displays the tree using a Flash control
- object: returns the tree as a ColdFusion structure with the
name specified by the name attribute, For details of the
structure contents, see "object format", below.
- xml: Generates an XMLrepresentation of the tree.
In XML format forms, includes the generated XML in the
form. and puts the XML in a string variable with the name
specified by the name attribute.
Default: applet
]]></help>
<values default="applet">
<value option="applet"/>
<value option="flash"/>
<value option="html"/>
<value option="object"/>
<value option="xml"/>
</values>
</parameter>
<parameter name="required" required="false" type="boolean">
<help><![CDATA[
- true: user must select an item in tree control
- false: they do not
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="delimiter" required="false" type="String">
<help><![CDATA[
Character to separate elements in form variable path.
Default: \\
]]></help>
<values default="\\">
<value option="\\"/>
<value option=","/>
<value option=";"/>
<value option="|"/>
<value option=":"/>
</values>
</parameter>
<parameter name="completepath" required="false" type="boolean">
<help><![CDATA[
- true: start the Form.treename.path variable with the root
of the tree path when cftree is submitted.
- false: omit the root level from the Form.treename.path
variable; the value starts with the first child node in the
tree.
For the preserveData attribute of cfform to work with the
tree, you must set this attribute to Yes.
For tree items populated by a query, if you use the
cftreeitem queryasroot attribute to specify a root name,
that value is returned. If you do not specify a root name,
ColdFusion returns the query name.
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="Object"/>
</triggers>
</parameter>
<parameter name="appendkey" required="false" type="boolean">
<help><![CDATA[
- true: if you use cftreeitem href attributes, ColdFusion
appends a CFTREEITEMKEY query string variable with
the value of the selected tree item to the cfform action URL.
- false: do not append the tree item value to the URL.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="highlighthref" required="false" type="boolean">
<help><![CDATA[
- true: highlights as a link the displayed value for any
cftreeitem tag that specifies a href attribute.
- false: disables highlighting.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="onvalidate" required="false" type="String">
<help><![CDATA[
JavaScript function to validate user input. The form object,
input object, and input object value are passed to the
specified routine, which should return True if validation
succeeds; False, otherwise.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="message" required="false" type="String">
<help><![CDATA[
Message to display if validation fails.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="onerror" required="false" type="String">
<help><![CDATA[
JavaScript function to execute if validation fails.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="lookandfeel" required="false" type="String">
<help><![CDATA[
- motif: renders slider in Motif style
- windows: renders slider in Windows style
- metal: renders slider in Java Swing style
If platform does not support style option, tag defaults to
platform default style.
Default: windows
]]></help>
<values default="windows">
<value option="motif"/>
<value option="windows"/>
<value option="metal"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="Object"/>
</triggers>
</parameter>
<parameter name="font" required="false" type="String">
<help><![CDATA[
Font name for data in tree control.
]]></help>
<values default="arial">
<value option="arial"/>
<value option="times"/>
<value option="courier"/>
<value option="arialunicodeMS"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="fontsize" required="false" type="Numeric">
<help><![CDATA[
Font size for text in tree control, in points.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="italic" required="false" type="boolean">
<help><![CDATA[
- true: displays tree control text in italics
- false: it does not
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="bold" required="false" type="boolean">
<help><![CDATA[
- true: displays tree control text in bold
- false: it does not
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
Tree control height, in pixels. If you omit this attribute in
Flash format, Flash automatically sizes the tree.
Default: 320 (applet only)
]]></help>
<values default="320"/>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Tree control width, in pixels. If you omit this attribute in
Flash format, Flash automatically sizes the tree.
Default: 200 (applet only)
]]></help>
<values default="200"/>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="vspace" required="false" type="Numeric">
<help><![CDATA[
Vertical margin above and below tree control, in pixels.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="Object"/>
</triggers>
</parameter>
<parameter name="hspace" required="false" type="Numeric">
<help><![CDATA[
Horizontal spacing to left and right of tree control, in pixels.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="Object"/>
</triggers>
</parameter>
<parameter name="align" required="false" type="String">
<help><![CDATA[
Alignment of the tree control applet object.
]]></help>
<values>
<value option="top"/>
<value option="left"/>
<value option="bottom"/>
<value option="baseline"/>
<value option="texttop"/>
<value option="absbottom"/>
<value option="middle"/>
<value option="absmiddle"/>
<value option="right"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="Object"/>
</triggers>
</parameter>
<parameter name="border" required="false" type="boolean">
<help><![CDATA[
- true: display a border around the tree control.
- false: no border
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="Object"/>
</triggers>
</parameter>
<parameter name="hscroll" required="false" type="boolean">
<help><![CDATA[
- true: permits horizontal scrolling
- false: no horizontal scrolling
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="Object"/>
</triggers>
</parameter>
<parameter name="vscroll" required="false" type="boolean">
<help><![CDATA[
- true: permits vertical scrolling
- false: no vertical scrolling
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
<selectedValue attributeName="format"
required="false" value="Object"/>
</triggers>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
Flash only: Must be a style specification in CSS format, with the same
syntax and contents as used in Macromedia Flex for the
corresponding Flash element.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="enabled" required="false" type="boolean">
<help><![CDATA[
Flash only: Boolean value specifying whether the
control is enabled. A disabled control appears in light gray.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="visible" required="false" type="boolean">
<help><![CDATA[
Flash only: Boolean value specifying whether to
show the control. Space that would be occupied by an
invisible control is blank.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="tooltip" required="false" type="String">
<help><![CDATA[
Flash only: Text to display when the mouse pointer
hovers over the control.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="onchange" required="false" type="String">
<help><![CDATA[
Flash only: ActionScript to run when the control changes due to user action.
If you specify an onChange event handler, the Form scope of
the ColdFusion action page does not automatically get
information about selected items. The ActionScript onChange
event handler must handle all changes and selections.
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="onblur" required="false" type="String">
<help><![CDATA[
Flash only: ActionScript that runs when the calendar loses focus.
(Added in 7.0.1)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="onfocus" required="false" type="String">
<help><![CDATA[
Flash only: ActionScript that runs when the calendar loses focus.
(Added in 7.0.1)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="format"
required="false" value="flash"/>
</triggers>
</parameter>
<parameter name="notsupported" required="false" type="String">
<help><![CDATA[
Text to display if a page that contains a Java applet-based
cfform control is opened by a browser that does not
support Java or has Java support disabled.
Default:
"<b>Browser must support Java to <br>view ColdFusion Java
Applets!</b>"
]]></help>
<values default="<b>Browser must support Java to <br>view ColdFusion Java Applets!</b>"/>
<triggers>
<selectedValue attributeName="format"
required="false" value="applet"/>
</triggers>
</parameter>
<parameter name="cache" required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies whether to get new data each time the user expands tree nodes, as follows:
* yes: fetches a node's child items only once, when the node is first expanded
* no: fetches child items each time the node is expanded.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>align,appendkey,bold,border,cache,completepath,delimiter,enabled,font,fontsize,format,height,highlighthref,hscroll,hspace,italic,label,lookandfeel,message,notsupported,onblur,onchange,onerror,onfocus,onvalidate,required,style,tooltip,value,visible,vscroll,vspace,width</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cftreeitem
value = "text"
display = "text"
parent = "parent_name"
img = "filename"
imgopen = "filename"
href = "URL"
target = "URL_target"
query = "queryname"
queryAsRoot = "boolean"
expand = "boolean"
-->
<tag endtagrequired="false" name="cftreeitem" single="true"
xmlstyle="false">
<help><![CDATA[
Populates a form tree control, created with the cftree tag,
with elements. To display icons, you can use the img values
that CFML provides, or reference your own icons.
]]></help>
<parameter name="bind" required="false" type="String">
<help><![CDATA[
A bind expression specifying a CFC of JavaScript
function that dynamically gets all tree nodes. You can use
this attribute only at the top level of the tree, and in this
case, the tree can have only cftreeitem tag.
If you use the bind attribute, the only other allowed
attribute is onBindError. For details creating trees that
using binding, see "Using HTML format trees" in Chapter
33, "Using AJAX UI Components and Features" in
ColdFusion Developer's Guide
]]></help>
<values/>
</parameter>
<parameter name="value" required="false" type="String">
<help><![CDATA[
Value passed when cfform is submitted. When populating a
tree with data from a cfquery, specify columns in a
delimited list. Example: value = "dept_id,emp_id"
]]></help>
<values/>
</parameter>
<parameter name="display" required="false" type="String">
<help><![CDATA[
Tree item label. When populating a tree with data from a
query, specify names in a delimited list. Example:
display = "dept_name,emp_name"
]]></help>
<values/>
</parameter>
<parameter name="parent" required="false" type="String">
<help><![CDATA[
Value for tree item parent.
]]></help>
<values/>
</parameter>
<parameter name="img" required="false" type="String">
<help><![CDATA[
Image name, filename, or file URL for tree item icon.
You can specify a custom image. To do so, include path and
file extension; for example:
img = "../images/page1.gif"
To specify more than one image in a tree, or an image at
the second or subsequent level, use commas to separate
names, corresponding to level; for example:
img = "folder,document"
img = ",document" (example of second level)
]]></help>
<values>
<value option="cd"/>
<value option="computer"/>
<value option="document"/>
<value option="element"/>
<value option="folder"/>
<value option="floppy"/>
<value option="fixed"/>
<value option="remote"/>
</values>
</parameter>
<parameter name="imgopen" required="false" type="String">
<help><![CDATA[
Icon displayed with open tree item. You can specify icon
filename with a relative path. You can use a CFML
image.
]]></help>
<values/>
</parameter>
<parameter name="href" required="false" type="String">
<help><![CDATA[
URL to associate with tree item or query column for a tree
that is populated from a query. If href is a query column,
its value is the value populated by query. If href is not
recognized as a query column, it is assumed that its text
is an HTML href.
When populating a tree with data from a query, HREFs can be
specified in delimited list; for example:
href = "http://dept_svr,http://emp_svr"
]]></help>
<values/>
</parameter>
<parameter name="target" required="false" type="String">
<help><![CDATA[
Target attribute of href URL. When populating a tree with
data from a query, specify target in delimited list:
target = "FRAME_BODY,_blank"
]]></help>
<values/>
</parameter>
<parameter name="query" required="false" type="String">
<help><![CDATA[
Query name to generate data for the treeitem.
]]></help>
<values/>
</parameter>
<parameter name="queryAsRoot" required="false" type="String">
<help><![CDATA[
Defines query as the root level. This avoids having to
create another parent cftreeitem.
* Yes
* No
* String to use as the root name
If you do not specify a root name, CFML returns the
query name as the root.
]]></help>
<values/>
</parameter>
<parameter name="expand" required="false" type="boolean">
<help><![CDATA[
Yes: expands tree to show tree item children
No: keeps tree item collapsed
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="onbinderror" required="false" type="String">
<help><![CDATA[
The name of a JavaScript function to execute if evaluating a bind expression results in an error. The function must take two attributes: an HTTP status code and a message.
]]></help>
</parameter>
<possiblecombinations/>
</tag>
<!--
cftry
Code that might throw an exception
One or more cfcatch blocks
/cftry
-->
<tag endtagrequired="true" canHaveAttributeCollection="false" name="cftry" single="false"
xmlstyle="false">
<help><![CDATA[
Used with one or more cfcatch tags. Together, they catch and
process exceptions in CFML pages. Exceptions are events
that disrupt the normal flow of instructions in a CFML
page, such as failed database operations, missing include
files, and developer-specified events.
]]></help>
</tag>
<!--
cfupdate
dataSource = "ds_name"
tableName = "table_name"
tableOwner = "name"
tableQualifier = "qualifier"
username = "username"
password = "password"
formFields = "field_names"
-->
<tag endtagrequired="false" name="cfupdate" single="true"
xmlstyle="false">
<help><![CDATA[
Updates records in a data source from data in a CFML form
or form Scope.
]]></help>
<parameter name="datasource" required="true" type="String">
<help><![CDATA[
Name of the data source that contains the table
]]></help>
<values/>
</parameter>
<parameter name="tablename" required="true" type="String">
<help><![CDATA[
Name of table to update.
For ORACLE drivers, must be uppercase.
For Sybase driver: case-sensitive; must be in same case
as used when the table was created
]]></help>
<values/>
</parameter>
<parameter name="tableowner" required="false" type="String">
<help><![CDATA[
For data sources that support table ownership (for example,
SQL Server, Oracle, Sybase SQL Anywhere), the table owner.
]]></help>
<values/>
</parameter>
<parameter name="tablequalifier" required="false" type="String">
<help><![CDATA[
For data sources that support table qualifiers. The purpose
of table qualifiers is as follows:
SQL Server and Oracle: name of database that contains
table
Intersolv dBASE driver: directory of DBF files
]]></help>
<values/>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
Overrides username value specified in ODBC setup.
]]></help>
<values/>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Overrides password value specified in ODBC setup.
]]></help>
<values/>
</parameter>
<parameter name="formfields" required="false" type="String">
<help><![CDATA[
Comma-delimited list of form fields to update.
If a form field is not matched by a column name in the
database, CFML throws an error.
The formFields lies must include the database table primary
key field, which must be present in the form. It can be
hidden.
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="tablename">
<required>dbtype,tablename</required>
<optional>connectstring,datasource,dbname,dbpool,dbserver,formfields,password,provider,providerdsn,tableowner,tablequalifier,username</optional>
</combination>
<combination attributename="tablename">
<required>datasource,tablename</required>
<optional>connectstring,dbname,dbpool,dbserver,dbtype,formfields,password,provider,providerdsn,tableowner,tablequalifier,username</optional>
</combination>
</possiblecombinations>
</tag>
<!--
cfwddx
action = "action"
input = "inputdata"
output = "resultvariablename"
topLevelVariable = "toplevelvariablenameforjavascript"
useTimeZoneInfo = "boolean"
validate = "boolean"
-->
<tag endtagrequired="false" name="cfwddx" single="true"
xmlstyle="false">
<help><![CDATA[
Serializes and deserializes CFML data structures to the
XML-based WDDX format. The WDDX is an XML vocabulary for
describing complex data structures in a standard, generic way.
Implementing it lets you use the HTTP protocol to such
information among application server platforms, application
servers, and browsers.
This tag generates JavaScript statements to instantiate
JavaScript objects equivalent to the contents of a WDDX packet
or CFML data structure. Interoperates with Unicode.
]]></help>
<return parameter="output" type="Any"/>
<parameter isswitchattribute="true" name="action"
required="true" type="String">
<help><![CDATA[
cfml2wddx: serialize CFML to WDDX
wddx2cfml: deserialize WDDX to CFML
cfml2js: serialize CFML to JavaScript
wddx2js: deserialize WDDX to JavaScript
]]></help>
<values>
<value option="cfml2wddx"/>
<value option="wddx2cfml"/>
<value option="cfml2js"/>
<value option="wddx2js"/>
</values>
</parameter>
<parameter name="input" required="true" type="String">
<help><![CDATA[
A value to process
]]></help>
<values/>
</parameter>
<parameter name="output" required="false" type="variableName">
<help><![CDATA[
Name of variable for output. If action = "WDDX2JS" or
"CFML2JS", and this attribute is omitted, result is output
in HTML stream.
]]></help>
<values/>
</parameter>
<parameter name="toplevelvariable" returnVarType="variablename" required="false" type="String">
<help><![CDATA[
Name of top-level JavaScript object created by
deserialization. The object is an instance of the
WddxRecordset object.
]]></help>
<values/>
</parameter>
<parameter name="usetimezoneinfo" required="false" type="boolean">
<help><![CDATA[
Whether to output time-zone information when serializing
CFML to WDDX.
- Yes: the hour-minute offset, represented in ISO8601
format, is output.
- No: the local time is output.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="validate" required="false" type="boolean">
<help><![CDATA[
Applies if action = "wddx2cfml" or "wddx2js".
- Yes: validates WDDX input with an XML parser using
WDDX DTD. If parser processes input without error,
packet is deserialized. Otherwise, an error is
thrown.
- No: no input validation
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="wddx2cfml">
<required>input,output</required>
<optional>validate</optional>
</combination>
<combination switchvalue="cfml2js">
<required>input,toplevelvariable</required>
<optional>output</optional>
</combination>
<combination switchvalue="wddx2js">
<required>input,toplevelvariable</required>
<optional>output,validate</optional>
</combination>
<combination switchvalue="cfml2wddx">
<required>input</required>
<optional>output,usetimezoneinfo</optional>
</combination>
</possiblecombinations>
</tag>
<!--
<cfwindow
optional
bodyStyle = "CSS style specification"
center="true|false"
closable="true|false"
draggable="true|false"
headerStyle = "CSS style specification"
height="number of pixels"
initShow=""
minHeight=""
minWidth=""
modal="true|false"
name="string"
onBindError = "JavaScript function name"
resizable="true|false"
source="path"
title="string"
width="number of pixels"
x="numeric pixel coordinate"
y="numeric pixel coordinate">
window contents
</cfwindow>
-->
<tag endtagrequired="true" name="cfwindow" single="false"
xmlstyle="true">
<help><![CDATA[
Creates a pop-up window in the browser. Does not create a
separate browser pop-up instance.
]]></help>
<parameter name="bodyStyle" required="false" type="String">
<help><![CDATA[
A CSS style specification for the window body. As a
general rule, use this attribute to set color and
font styles. Using this attribute to set the height
and width, for example, can result in distorted output.
]]></help>
<values/>
</parameter>
<parameter name="center" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether to center
the window over the browser window.
• If true, ColdFusion ignores the x and y
attribute values.
• If false, and you do not specify x and y
attributes, ColdFusion centers the window.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="closable" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether the user can
close the window. If true, the window has an X
close icon.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="draggable" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether the user can
drag the window. To drag the window, click the
mouse on the title bar and hold the button down
while dragging. If the window does not have a
title, users cannot drag it.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="headerStyle" required="false" type="String">
<help><![CDATA[
A CSS style specification for the window header.
As a general rule, use this attribute to set
color and font styles. Using this attribute to
set the height and width, for example, can
result in distorted output.
]]></help>
<values/>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
Height of the window in pixels. If you specify
a value greater than the available space, the
window occupies the available space and the
resize handles do not appear. Default is 300.
]]></help>
<values/>
</parameter>
<parameter name="initShow" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether to display
the window when the containing page first displays.
If this value is false, use the
ColdFusion.Layout.show JavaScript function to
display the window.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="minHeight" required="false" type="Numeric">
<help><![CDATA[
The minimum height, in pixels, to which users
can resize the window. Default is 0.
]]></help>
<values/>
</parameter>
<parameter name="minWidth" required="false" type="Numeric">
<help><![CDATA[
The minimum width, in pixels, to which users
can resize the window. Default is 0.
]]></help>
<values/>
</parameter>
<parameter name="modal" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether the window
is modal, that is, whether the user can interact
with the main window while this window displays.
If true, the user cannot interact with the main
window.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
The name of the window. Must be unique on the
pages. This attribute is required to interact
with the window, including to dynamically show
or hide it.
]]></help>
<values/>
</parameter>
<parameter name="onBindError" required="false" type="String">
<help><![CDATA[
The name of a JavaScript function to execute
if evaluating a bind expression results in an
error. The function must take two attributes:
an HTTP status code and a message.
If you omit this attribute, and have specified
a global error handler
(by using the ColdFusion.setGlobalErrorHandlerfunction ),
it displays the error message; otherwise a default
error pop-up displays.
]]></help>
<values/>
</parameter>
<parameter name="resizable" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether the user can
resize the window.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="source" required="false" type="String">
<help><![CDATA[
A URL that returns the window contents. This
attribute can use URL parameters to pass data
to the page. ColdFusion uses standard page path
resolution rules to locate the page. You can use
a bind expressions in this attribute; for more
information see the Usage section. Note: If a
CFML page specified in this attribute contains
tags that use AJAX features, such as cfform,
cfgrid, and cfpod, you must use a cfajaximport
tag on the page with the cfwindow tag.
For more information, see cfajaximport
]]></help>
<values/>
</parameter>
<parameter name="title" required="false" type="String">
<help><![CDATA[
Text to display in the window's title bar. You
can use HTML mark up to control the title
appearance, of example to show the text in
red italic font. If you omit this attribute,
the window does not have a title bar.
]]></help>
<values/>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Width of the control, including the title bar
and borders, in pixels. Default is 500.
]]></help>
<values/>
</parameter>
<parameter name="x" required="false" type="Numeric">
<help><![CDATA[
The X (horizontal) coordinate of the upper-left
corner of the window, relative to the browser
window. ColdFusion ignores this attribute if
the center attribute value is true and if you
do not set the y attribute value.
]]></help>
<values/>
</parameter>
<parameter name="y" required="false" type="Numeric">
<help><![CDATA[
The Y (vertical) coordinate of the upper-left
corner of the window, relative to the browser
window. ColdFusion ignores this attribute if
the center attribute value is true and if you
do not set the x attribute value.
]]></help>
<values/>
</parameter>
<parameter name="refreshonshow" required="false" type="Boolean">
<help><![CDATA[
* true Refresh the contents of the window by running the source bind expression whenever the window shows (for example, by calling the ColdFusion.Window.show JavaScript function), in addition to when bind events occur
* false Refresh the window only when the bind expression is triggered by its bind event.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="destroyOnClose" required="false" type="Boolean">
<help><![CDATA[
When destroyOnClose is true, destroys the window when it is closed. By default, this is is false and the window is hidden when it is closed.
]]></help>
<values >
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations/>
</tag>
<!--
cfxml
variable="xmlVarName"
caseSensitive="boolean"
/cfxml
-->
<tag endtagrequired="true" name="cfxml" single="false"
xmlstyle="false">
<help><![CDATA[
Creates a CFML XML document object that contains the
markup in the tag body. This tag can include XML and CFML tags.
CFML processes the CFML code in the tag body, then assigns
the resulting text to an XML document object variable.
]]></help>
<return parameter="variable" type="xml"/>
<parameter name="variable" required="true" returnVarType="xml" type="String">
<help><![CDATA[
Name of an xml variable
]]></help>
<values/>
</parameter>
<parameter name="casesensitive" required="false" type="boolean">
<help><![CDATA[
Maintains the case of document elements and attributes
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</tag>
<tag creator="8" endtagrequired="false" name="cfajaximport"
single="true"
xmlstyle="false">
<help><![CDATA[
Controls the JavaScript files that are imported for use on pages that use ColdFusion AJAX
tags and features.
]]></help>
<parameter name="scriptsrc" required="false" type="String">
<help><![CDATA[
Specifies the URL, relative to the web root, of the
directory that contains the JavaScript files used
used by ColdFusion. When you use this attribute,
the specified directory must have the same
structure as the /CFIDE/scripts directory.
]]></help>
</parameter>
<parameter name="csssrc" required="false" type="String">
<help><![CDATA[
Specifies the URL, relative to the web root, of the
directory that contains the CSS files used by
ColdFusion AJAX features, with the exception of
the rich text editor. This directory must have the
same directory structure, and contain the same
CSS files, and image files required by the CSS
files, as the
web_root/CFIDE/scripts/ajax/resources
directory.
This attribute lets you create different custom
styles for ColdFusion AJAX controls in different
applications.
]]></help>
</parameter>
<parameter name="tags" required="false" type="String">
<help><![CDATA[
A comma-delimited list of tags or tag-attribute
combinations for which to import the supporting
JavaScript files on this page.
]]></help>
</parameter>
<parameter name="attributecollection" required="false" type="String">
<help><![CDATA[
You can specify this tag's attributes in an attributeCollection whose value is a
structure. Specify the structure name in the attributeCollection and use the tag’s
attribute names as structure keys.
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<tag creator="8" endtagrequired="true" name="cfmenu"
single="false"
xmlstyle="true">
<help><![CDATA[
Creates a menu or tool bar (a horizontally arranged menu). Any menu item can be the top
level of a submenu.
]]></help>
<parameter name="bgcolor" required="false" type="String">
<help><![CDATA[
The color of the menu background. You can
use any valid HTML color specification.
This specification is locally overridden by the
menuStyle attribute of this tag and any
cfmenuitem tag, but does affect the background
of the surrounding color of a submenu whose
background is controlled by a childStyle
attribute
]]></help>
</parameter>
<parameter name="childstyle" required="false" type="String">
<help><![CDATA[
A CSS style specification that applies to the
items of the top level menu and all child menu
items, including the children of submenus. This
attribute lets you use a single style specification
for all menu items.
]]></help>
</parameter>
<parameter name="font" required="false" type="String">
<help><![CDATA[
The font to be use for all child menu items. You
can use any valid HTML font-family style
attribute.
]]></help>
</parameter>
<parameter name="fontcolor" required="false" type="String">
<help><![CDATA[
The color of the menu text. You can use any
valid HTML color specification.
]]></help>
</parameter>
<parameter name="fontsize" required="false" type="String">
<help><![CDATA[
The size of the font. Use a numeric value, such
as 8, to specify a pixel character size. Use a
percentage value, such as 80% to specify a
size relative to the default font size.
Font sizes over 20 pixels can result in submenu
text exceeding the menu boundary.
]]></help>
</parameter>
<parameter name="menustyle" required="false" type="String">
<help><![CDATA[
A CSS style specification that applies to the
menu, including any parts of the menu that do not
have items. If you do not specify style information
in the cfmenuitem tags, this attribute controls the
style of the top-level items.
]]></help>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
The name of the menu.
]]></help>
</parameter>
<parameter name="selectedfontcolor" required="false" type="String">
<help><![CDATA[
The color of the text for the menu item that has
the focus. You can use any valid HTML color
specification.
]]></help>
</parameter>
<parameter name="selecteditemcolor" required="false" type="String">
<help><![CDATA[
The color that highlights the menu item that has
the focus. You can use any valid HTML color
specification.
]]></help>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
The orientation of menu.
]]></help>
<values default="horizontal">
<value option="horizontal"/>
<value option="vertical"/>
</values>
</parameter>
<parameter name="width" required="false" type="String">
<help><![CDATA[
The width of a vertical menu; not valid for
horizontal menus.
]]></help>
</parameter>
<possiblecombinations/>
</tag>
<tag creator="8" endtagrequired="true" name="cfmenuitem"
single="false"
xmlstyle="true">
<help><![CDATA[
Defines an entry in a menu, including an item that is the head of a submenu.
]]></help>
<parameter name="display" required="false" type="String">
<help><![CDATA[
The text to show as the menu item label.
]]></help>
</parameter>
<parameter name="childstyle" required="false" type="String">
<help><![CDATA[
A CSS style specification that applies to all child
menu items, including the children of submenus.
]]></help>
</parameter>
<parameter name="divider" required="false" type="String">
<help><![CDATA[
This attribute specifies that the item is a divider. If
you specify this attribute, you cannot specify any
other attributes.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="href" required="false" type="String">
<help><![CDATA[
A URL link to activate or JavaScript function to
call when the user clicks the menu item.
]]></help>
</parameter>
<parameter name="image" required="false" type="String">
<help><![CDATA[
URL of an image to display at the left side of the
menu item. The file type can be any format the
browser can display.
For most displays, you should use 15x15 pixel
images, because larger images conflict with the
menu item text
]]></help>
</parameter>
<parameter name="menustyle" required="false" type="String">
<help><![CDATA[
A CSS style specification that controls the overall
style of any submenu of this menu item. This
attribute controls the submenu of the current menu
item, but not to any child submenus of the submenu.
]]></help>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
The name of the menu item.
]]></help>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
A CSS style specification that applies to the current
menu item only. It is not overridden by the
childStyle attribute.
]]></help>
</parameter>
<parameter name="target" required="false" type="String">
<help><![CDATA[
The target in which to display the contents
returned by the href attribute. The attribute can be
a browser window or frame name, an HTML target
value, such as _self.
]]></help>
</parameter>
<possiblecombinations/>
</tag>
<tag creator="8" endtagrequired="false" name="cfprint"
single="true"
xmlstyle="false">
<help><![CDATA[
Prints specified pages from a PDF file. Use this tag to perform automated batch print jobs.
You can use the cfprint tag to print any PDF document, including those generated by the
cfdocument, cfpdf, and cfpdfform tag. Also, you can use this tag to print Report Builder
reports exported in PDF format.
]]></help>
<parameter name="source" required="false" type="String">
<help><![CDATA[
Source document to print. You can specify
one of the following:
• An absolute or relative pathname to a PDF
document; for example,
c:\work\myPDF.pdf or myPDF.pdf. The
default directory is the template directory.
• A PDF document variable in memory that
is generated by the cfdocument tag or the
cfpdf tag; for example, "myPDFdoc".
]]></help>
</parameter>
<parameter name="attributestruct" required="false" type="String">
<help><![CDATA[
ColdFusion structure used to specify
additional print instructions. Individually
named attributes take precedence over the
key-value pairs in the attribute structure.
]]></help>
</parameter>
<parameter name="copies" required="false" type="String">
<help><![CDATA[
Number of copies to print. The value must be
greater than or equal to 1.
]]></help>
</parameter>
<parameter name="jobname" required="false" type="String">
<help><![CDATA[
The name of a print job.
]]></help>
</parameter>
<parameter name="orientation" required="false" type="String">
<help><![CDATA[
Orientation of the page to be printed.
]]></help>
<values>
<value option="portrait"/>
<value option="landscape"/>
<value option="reverse-portrait"/>
<value option="reverse-landscape"/>
</values>
</parameter>
<parameter name="pages" required="false" type="String">
<help><![CDATA[
Pages in the source file to print. Duplicate
pages and pages beyond the total count of
pages in the document are ignored as long
as there is at least one page between 1 and
the total number of pages in the document.
You can combine individual page numbers
and page ranges; for example, 1–3,6,10–20.
If you do not specify a value for the pages
attribute, ColdFusion prints the entire
document.
]]></help>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Specifies either the owner or user password
for the PDF source file. If the PDF file is
password-protected, you must specify this
attribute for the file to print.
]]></help>
</parameter>
<parameter name="papersize" required="false" type="String">
<help><![CDATA[
Paper used for the print job. The value can be
any returned by the GetPrinterInfo
function. Valid
]]></help>
<values>
<value option="letter"/>
<value option="legal"/>
<value option="a4"/>
<value option="a5"/>
<value option="b4"/>
<value option="b5"/>
<value option="b4-jis"/>
<value option="b5-jis"/>
</values>
</parameter>
<parameter name="quality" required="false" type="String">
<help><![CDATA[
Print quality for the print job:
* draft
* high
* normal
]]></help>
<values>
<value option="normal"/>
<value option="draft"/>
<value option="high"/>
</values>
</parameter>
<parameter name="color" required="false" type="String">
<help><![CDATA[
Color or monochrome printing
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="coverpage" required="false" type="String">
<help><![CDATA[
Specifies which job start and end sheets, if any, are printed with a job:
* none
* standard
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter isswitchattribute="true" name="type"
required="false" type="String">
<help><![CDATA[
Specifies the file type of the document being
printed. PDF is the only valid value.
]]></help>
<values>
<value option="pdf"/>
</values>
</parameter>
<parameter name="printer" required="false" type="String">
<help><![CDATA[
The name of a printer. An example in
Windows is “\\s1001prn02\NTN-2W-
HP_BW02”. The default is the default printer
for the account where the ColdFusion server
is running.
]]></help>
</parameter>
<parameter name="sides" required="false" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="duplex"/>
<value option="one-sided"/>
<value option="tumble"/>
<value option="two-sided-long-edge"/>
<value option="two-sided-short-edge"/>
</values>
</parameter>
<parameter name="paper" required="false" type="String">
<help><![CDATA[
Paper used for the print job. The value can be any returned by the GetPrinterInfo function.
]]></help>
<values>
<value option="na-letter"/>
<value option="na-legal"/>
<value option="iso-a4"/>
<value option="iso-a5"/>
<value option="iso-b4"/>
<value option="iso-b5"/>
<value option="jis-b4"/>
<value option="jis-b5"/>
</values>
</parameter>
<parameter name="fidelity" required="false" type="Boolean">
<help><![CDATA[
Whether to print a job based on the print requirements specified. Valid values are:
* yes: if the job cannot be printed exactly as specified in the print requirements, the job is rejected.
* no: a reasonable attempt to print the job is acceptable
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="pdf">
<required>source</required>
<optional>attributestruct,color,copies,fidelity,pages,paper,password,printer,type</optional>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="false" name="cfsprydataset"
single="true"
xmlstyle="false">
<help><![CDATA[
Creates a Spry data set; can use bind parameters to get data from ColdFusion AJAX controls
to populate the data set.
]]></help>
<parameter name="bind" required="true" type="String">
<help><![CDATA[
A bind expression that returns XML data to populate
the Spry data set. The bind expression can specify a
CFC function or URL and can include bind parameters
that represent the values of ColdFusion controls. For
detailed information on specifying bind expressions,
see HTML form data binding in cfinput.
]]></help>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
The name of the Spry data set.
]]></help>
</parameter>
<parameter name="onbinderror" required="false" type="String">
<help><![CDATA[
The name of a JavaScript function to execute if
evaluating the bind expression results in an error. The
function must take two attributes: an HTTP status
code and a message.
If you omit this attribute, and have specified a global
error handler (by using the
ColdFusion.setGlobalErrorHandler function), the
handler displays the error message; otherwise a
default error pop-up displays.
]]></help>
</parameter>
<parameter name="options" required="false" type="String">
<help><![CDATA[
A JavaScript object containing options to pass to the
data set.
]]></help>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
Specifies data set type, corresponding to the format of
the data that is returned by the bind expression.
]]></help>
<values>
<value option="xml"/>
<value option="json"/>
</values>
</parameter>
<parameter name="xpath" required="false" type="String">
<help><![CDATA[
Valid for XML type data sets only. An XPath
expression that extracts data from the XML returned
by the bind expression. The data set contains only the
data that matches the xpath expression.
]]></help>
</parameter>
<possiblecombinations/>
</tag>
<tag creator="8" endtagrequired="true" name="cftooltip"
single="false"
xmlstyle="true">
<help><![CDATA[
Specifies tool tip text that displays when the user hovers the mouse pointer over the elements
in the tag body. This tag does not require a form and is not used inside Flash forms.
]]></help>
<parameter name="preventoverlap" required="false" type="String">
<help><![CDATA[
A Boolean value specifying whether to prevent the
tooltip from overlapping the component that it
describes.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="autodismissdelay" required="false" type="String">
<help><![CDATA[
The number of milliseconds between the time
when the user moves the mouse pointer over the
component (and leaves it there) and when the
tooltip disappears.
]]></help>
</parameter>
<parameter name="hidedelay" required="false" type="String">
<help><![CDATA[
The number of milliseconds to delay between the
time when the user moves the mouse pointer away
from the component and when the tooltip
disappears.
]]></help>
</parameter>
<parameter name="showdelay" required="false" type="String">
<help><![CDATA[
The number of milliseconds to delay between the
time when the user moves the mouse over the
component and when the tooltip appears.
]]></help>
</parameter>
<parameter name="sourcefortooltip" required="false" type="String">
<help><![CDATA[
The URL of a page with the tool tip contents. The
page can include HTML markup to control the
format, and the tip can include images.
If you specify this attribute, an animated icon
appears with the text "Loading..." while the tip is
being loaded.
]]></help>
</parameter>
<parameter name="tooltip" required="false" type="String">
<help><![CDATA[
Tip text to display. The text can include HTML
formatting.
Ignored if you specify a sourceForTooltip attribute
]]></help>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
]]></help>
</parameter>
<possiblecombinations/>
</tag>
<tag creator="8" endtagrequired="false" name="cfajaxproxy"
single="true" xmlstyle="false">
<help><![CDATA[
Creates a JavaScript proxy for a ColdFusion component, for use in an AJAX client.
]]></help>
<parameter name="cfc" required="false" type="String">
<help><![CDATA[
The CFC for which to create a proxy. You must specify a dot-delimited path to the CFC.
The path can be absolute or relative to location of the CFML page.
For example, if the myCFC CFC is in the cfcs subdirectory of the ColdFusion page, specify cfcs.myCFC.
On UNIX based systems, the tag searches first for a file whos name or path corresponds to the specified name or path, but is in all lower case.
If it does not find it, ColdFusion then searches for a file name or path that coresponds to the attribute value exactly, with identical character casing. (required)
]]></help>
<values/>
</parameter>
<parameter name="jsclassname" required="false" type="String">
<help><![CDATA[
The name to use for the JavaScript proxy class. (optional)
]]></help>
<values/>
</parameter>
<parameter name="bind" required="false" type="String">
<help><![CDATA[
A bind expression that specifies a CFC method, JavaScript function, or URL to call.
]]></help>
</parameter>
<parameter name="onerror" required="false" type="String">
<help><![CDATA[
The name of a JavaScript function to invoke when a bind, specified by the bind attribute fails. The function must take two arguments: an error code and an error message.
]]></help>
</parameter>
<parameter name="onsuccess" required="false" type="String">
<help><![CDATA[
The name of a JavaScript function to invoke when a bind, specified by the bind attribute succeeds. The function must take one argument, the bind function return value. If the bind function is a CFC function, the return value is automatically converted to a JavaScript variable before being passed to the onSuccess function.
]]></help>
</parameter>
<possiblecombinations/>
</tag>
<tag creator="8" endtagrequired="false"
name="cfexchangecalendar" single="true" xmlstyle="false">
<help><![CDATA[
Creates, deletes, modifies, gets, and responds to Microsoft Exchange calendar events, and gets calendar event attachments.
]]></help>
<return parameter="name" type="query"/>
<return parameter="result" type="String"/>
<parameter isswitchattribute="true" name="action"
required="true" type="String">
<help><![CDATA[
The action to take. Must be one of the following: create, delete, get, getAttachments, modify, respond (required)
]]></help>
<values>
<value option="create"/>
<value option="delete"/>
<value option="deleteAttachments"/>
<value option="get"/>
<value option="getAttachments"/>
<value option="modify"/>
<value option="respond"/>
</values>
</parameter>
<parameter name="attachmentpath" required="false" type="String">
<help><![CDATA[
The file path of the destination directory.
If the directory does not exist, ColdFusion creates it.
If you omit this attribute, ColdFusion does not save any attachments.
If you specify a relative path, the path root is the ColdFusion temporary directory, which is returned by the GetTempDirectory function. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="getAttachments"/>
</triggers>
</parameter>
<parameter name="connection" required="false" type="variablename">
<help><![CDATA[
The name of the connection to the Exchange server, as specified in the cfexchangeconnection tag.
If you omit this attribute, you must create a temporary connection by specifying cfexchangeconnection tag connection attributes in the cfexchangecalendar tag. (optional)
]]></help>
<values/>
</parameter>
<parameter name="event" required="true" type="any">
<help><![CDATA[
A reference to the structure that contains the event properties to be set or changed and their values.
You must specify this attribute in number signs (#). (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="create"/>
<selectedValue attributeName="action"
required="true" value="modify"/>
</triggers>
</parameter>
<parameter name="generateUniquefilenames" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether to generate unique file names if multiple attachments have the same file names.
Case "yes": 3x myfile.txt -> myfile.txt, myfile1.txt, and myfile2.txt. (optional, default=no)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="create"/>
</triggers>
</parameter>
<parameter name="message" required="false" type="String">
<help><![CDATA[
The text of an optional message to send in the response or deletion notification. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="delete"/>
<selectedValue attributeName="action"
required="false" value="respond"/>
</triggers>
</parameter>
<parameter name="name" required="true" returnVarType="query" type="String">
<help><![CDATA[
The name of the ColdFusion query variable that will contain the retrieved events or information about the attachments that were retrieved. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="get"/>
<selectedValue attributeName="action"
required="true" value="getAttachments"/>
</triggers>
</parameter>
<parameter name="notify" required="false" type="Boolean">
<help><![CDATA[
Boolean value specifying whether to notify others of the changes made to the event (optional)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="true" value="delete"/>
<selectedValue attributeName="action"
required="true" value="respond"/>
</triggers>
</parameter>
<parameter name="responseType" required="true" type="String">
<help><![CDATA[
(respond) Must be one of the following: accept, decline, tentative (required)
]]></help>
<values>
<value option="accept"/>
<value option="decline"/>
<value option="tentative"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="true" value="respond"/>
</triggers>
</parameter>
<parameter name="result" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
The name of a variable that will contain the UID of the event that is created.
You use the UID value in the uid attribute other actions to identify the event to be acted on. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="create"/>
</triggers>
</parameter>
<parameter name="uid" required="true" type="String">
<help><![CDATA[
Case-sensitive Exchange UID value or values that uniquely identify the event or events
on which to perform the action.
For the delete action, this attribute can be a comma delimited list of UID values.
The getAttachments, modify, and respond actions allow only a single UID value. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="getAttachments"/>
<selectedValue attributeName="action"
required="true" value="delete"/>
<selectedValue attributeName="action"
required="true" value="modify"/>
<selectedValue attributeName="action"
required="true" value="respond"/>
</triggers>
</parameter>
<possiblecombinations>
<combination switchvalue="deleteattachments">
<required>uid</required>
<optional>connection</optional>
</combination>
<combination switchvalue="modify">
<required>event,uid</required>
<optional>connection</optional>
</combination>
<combination switchvalue="respond">
<required>responsetype,uid</required>
<optional>connection,message,notify</optional>
</combination>
<combination switchvalue="create">
<required>event</required>
<optional>connection,result</optional>
</combination>
<combination switchvalue="get">
<required>name</required>
<optional>connection</optional>
</combination>
<combination switchvalue="delete">
<required>uid</required>
<optional>connection,message,notify</optional>
</combination>
<combination switchvalue="getattachments">
<required>name,uid</required>
<optional>attachmentpath,connection,generateuniquefilenames</optional>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="false"
name="cfexchangeconnection" single="true" xmlstyle="false">
<help><![CDATA[
Opens or closes a persistent connection to an Microsoft Exchange server.
You must have a persistent or temporary connection to use the cfexchangecalendar,
cfexchangecontact, cfexchangemail, and cfexchangetask tags to get or change
information on the Exchange server.
]]></help>
<return parameter="name" type="query"/>
<parameter isswitchattribute="true" name="action"
required="true" type="String">
<help><![CDATA[
The action to take. Must be open or close. (required)
]]></help>
<values>
<value option="open"/>
<value option="close"/>
<value option="getsubfolders"/>
</values>
</parameter>
<parameter name="connection" required="true" returnVarType="variablename" type="String">
<help><![CDATA[
The name of the connection. You specify this ID when you close the connection
and in tags such as cfexchangemail. (required)
]]></help>
<values/>
</parameter>
<parameter name="mailboxName" required="false" type="String">
<help><![CDATA[
The ID of the Exchange mailbox to use.
Specify this attribute to access a mailbox whose owner has delegated access
rights to the account specified in the username attribute. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="open"/>
</triggers>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
(open) The users password for accessing the Exchange server. (optional)
]]></help>
<values/>
</parameter>
<parameter name="port" required="false" type="Numeric">
<help><![CDATA[
The port on the server connect to, most commonly port 80. (optional)
]]></help>
<triggers>
<selectedValue attributeName="action"
required="false" value="open"/>
</triggers>
</parameter>
<parameter name="protocol" required="false" type="String">
<help><![CDATA[
The protocol to use for the connection. Valid values are http and https. (optional)
]]></help>
<values>
<value option="http"/>
<value option="https"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="open"/>
</triggers>
</parameter>
<parameter name="proxyHost" required="false" type="String">
<help><![CDATA[
The URL or IP address of the proxy host required for access to the network. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="open"/>
</triggers>
</parameter>
<parameter name="proxyPort" required="false" type="String">
<help><![CDATA[
The port on the proxy server to connect to, most commonly port 80. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="open"/>
</triggers>
</parameter>
<parameter name="server" required="true" type="String">
<help><![CDATA[
The IP address or URL of the server that is providing access to Exchange. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="open"/>
</triggers>
</parameter>
<parameter name="username" required="true" type="String">
<help><![CDATA[
The Exchange user ID (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="open"/>
</triggers>
</parameter>
<parameter name="folder" required="false" type="String">
<help><![CDATA[
The forward slash (/) delimited path from the root of the mailbox to the folder for which to get subfolders.
]]></help>
</parameter>
<parameter name="recurse" required="false" type="Boolean">
<help><![CDATA[
* true: get information on the immediate subfolders of the specified folder only.
* false: get information on all levels of subfolders of the specified folder.
]]></help>
<values default="false">
<value option="false"/>
<value option="true"/>
</values>
</parameter>
<parameter name="name" required="false" returnVarType="query" type="String">
<help><![CDATA[
The name of the ColdFusion query variable that contains information about the subfolders.
]]></help>
</parameter>
<parameter name="exchangeServerLanguage" required="false" type="String">
<help><![CDATA[
The language of the Exchange server. Default is English.
]]></help>
</parameter>
<parameter name="formBasedAuthentication" required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies whether to display a login form and use form based authentication when making the connection.
]]></help>
<values >
<value option="true" />
<value option="false" />
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="open">
<required>connection,server,username</required>
<optional>exchangeserverlanguage,formbasedauthentication,mailboxname,password,port,protocol,proxyhost,proxyport</optional>
</combination>
<combination switchvalue="close">
<required>connection</required>
<optional/>
</combination>
<combination switchvalue="getsubfolders">
<required>name</required>
<optional>connection,exchangeserverlanguage,folder,formbasedauthentication,mailboxname,password,port,protocol,proxyhost,proxyport,recurse,server,username</optional>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="false" name="cfexchangecontact"
single="true" xmlstyle="false">
<help><![CDATA[
Creates, deletes, modifies, and gets Microsoft Exchange contact records, and gets contact record attachments.
]]></help>
<return parameter="name" type="query"/>
<return parameter="result" type="String"/>
<parameter isswitchattribute="true" name="action"
required="true" type="String">
<help><![CDATA[
The action to take. Must be one of the following: create, delete, get, getAttachments, modify (required)
]]></help>
<values>
<value option="create"/>
<value option="delete"/>
<value option="deleteAttachments"/>
<value option="get"/>
<value option="getAttachments"/>
<value option="modify"/>
</values>
</parameter>
<parameter name="attachmentPath" required="false" type="String">
<help><![CDATA[
The absolute file path of the directory in which to put the attachments.
If the directory does not exist, ColdFusion creates it.
If you omit this attribute, ColdFusion does not save any attachments. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="getAttachments"/>
</triggers>
</parameter>
<parameter name="connection" required="false" type="variablename">
<help><![CDATA[
The name of the connection to the Exchange server, as specified in the cfexchangeconnection tag.
If you omit this attribute, you must create a temporary connection by specifying
cfexchangeconnection tag connection attributes in the cfexchangecontact tag. (optional)
]]></help>
<values/>
</parameter>
<parameter name="contact" required="true" type="any">
<help><![CDATA[
A reference to the structure that contains the contact properties to be set or changed and their values.
You must specify this attribute in number signs (#).
For more information on the event structure, see the Usage section. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="create"/>
<selectedValue attributeName="action"
required="true" value="modify"/>
</triggers>
</parameter>
<parameter name="generateUniqueFilenames" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether to generate unique file names if multiple attachments have the same file names.
Case "yes": 3x myfile.txt -> myfile.txt, myfile1.txt, and myfile2.txt. (optional, default=no)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="getAttachments"/>
</triggers>
</parameter>
<parameter name="name" required="true" returnVarType="query" type="String">
<help><![CDATA[
The name of the ColdFusion query variable that will contain the retrieved events or
information about the attachments that were retrieved. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="get"/>
<selectedValue attributeName="action"
required="true" value="getAttachments"/>
</triggers>
</parameter>
<parameter name="result" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
The name of a variable that will contain the UID of the contact that is created.
You use this value in the uid attribute other actions to identify the contact to be acted on. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="create"/>
</triggers>
</parameter>
<parameter name="uid" required="true" type="String">
<help><![CDATA[
A case-sensitive Exchange UID value that uniquely identifies the contacts on which to perform the action.
For the delete action, this attribute can be a comma delimited list of UID values.
The getAttachments and modify action allow only a single UID value. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="getAttachments"/>
<selectedValue attributeName="action"
required="true" value="delete"/>
<selectedValue attributeName="action"
required="true" value="modify"/>
</triggers>
</parameter>
<possiblecombinations>
<combination switchvalue="deleteattachments">
<required>uid</required>
<optional>connection</optional>
</combination>
<combination switchvalue="modify">
<required>contact,uid</required>
<optional>connection</optional>
</combination>
<combination switchvalue="create">
<required>contact</required>
<optional>connection,result</optional>
</combination>
<combination switchvalue="get">
<required>name</required>
<optional>connection</optional>
</combination>
<combination switchvalue="delete">
<required>uid</required>
<optional>connection</optional>
</combination>
<combination switchvalue="getattachments">
<required>name,uid</required>
<optional>attachmentpath,connection,generateuniquefilenames</optional>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="false" name="cfexchangefilter"
single="true" xmlstyle="false">
<help><![CDATA[
Specifies the filter parameter for cfexchangemail, cfexchangecalendar, cfexchangetask, and cfexchangecontact, get operations.
]]></help>
<parameter name="name" required="true" type="Any">
<help><![CDATA[
The type of filter to use. (required)
]]></help>
<values>
<value option="allDayEvent"/>
<value option="assistant"/>
<value option="attributes"/>
<value option="attributes"/>
<value option="bcc"/>
<value option="billingInfo"/>
<value option="businesAddress"/>
<value option="businessFax"/>
<value option="businessPhoneNumber"/>
<value option="cc"/>
<value option="companies"/>
<value option="company"/>
<value option="dateCompleted"/>
<value option="displayAs"/>
<value option="dueDate"/>
<value option="duration"/>
<value option="email1"/>
<value option="email2"/>
<value option="email3"/>
<value option="endTime"/>
<value option="firstName"/>
<value option="folder"/>
<value option="fromID"/>
<value option="hasAttachment"/>
<value option="homeAddress"/>
<value option="homePhoneNumber"/>
<value option="importance"/>
<value option="isRead"/>
<value option="isRecurring"/>
<value option="jobTitle"/>
<value option="lastName"/>
<value option="location"/>
<value option="mail_ID"/>
<value option="mailingAddressType"/>
<value option="manager"/>
<value option="meeting UIDs"/>
<value option="meeting_response"/>
<value option="meetingUID"/>
<value option="message"/>
<value option="messageType"/>
<value option="middleName"/>
<value option="mileage"/>
<value option="mobilePhoneNumber"/>
<value option="name"/>
<value option="nickName"/>
<value option="office"/>
<value option="optionalAttendees"/>
<value option="organizer"/>
<value option="otherAddress"/>
<value option="otherPhoneNumber"/>
<value option="profession"/>
<value option="requiredAttendees"/>
<value option="sensitivity"/>
<value option="spouseName"/>
<value option="startDate"/>
<value option="startTime"/>
<value option="status"/>
<value option="subject"/>
<value option="timeReceived"/>
<value option="timeSent"/>
<value option="toID"/>
<value option="totalWork"/>
<value option="UID"/>
<value option="Valid"/>
<value option="webPage"/>
<value option="lastModified"/>
<value option="recurrenceID"/>
<value option="maxRows"/>
</values>
</parameter>
<parameter name="from" required="false" type="any">
<help><![CDATA[
The start date or or date/time combination of the range to use for filtering.
Cannot be used with the value attribute.
If you specify a from attribute without a to attribute, the filter selects for
all entries on or after the specified date or time.
The value can be in any date/time format recognized by ColdFusion, but must
correspond to a value that is appropriate for the filter type. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="name" required="true" value="dueDate"/>
<selectedValue attributeName="name" required="true" value="startDate"/>
<selectedValue attributeName="name" required="true" value="timeReceived"/>
<selectedValue attributeName="name" required="true" value="timeSent"/>
</triggers>
</parameter>
<parameter name="to" required="false" type="any">
<help><![CDATA[
The end date or date/time combination for the range used for filtering.
Cannot be used with the value attribute.
If you specify a to attribute without a from attribute, the filter selects for
all entries on or before the specified date or time.
The value can be in any date/time format recognized by ColdFusion, but must
correspond to a value that is appropriate for the filter type. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="name" required="true" value="dueDate"/>
<selectedValue attributeName="name" required="true" value="startDate"/>
<selectedValue attributeName="name" required="true" value="timeReceived"/>
<selectedValue attributeName="name" required="true" value="timeSent"/>
</triggers>
</parameter>
<parameter name="value" required="false" type="any">
<help><![CDATA[
The filter value for all filters that do not take a date or time range.
Cannot be used with the from and to attributes.
If the name attribute requires this attribute, ColdFusion generates an error
if it has an empty or null value. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="name" required="true" value="actualWork"/>
<selectedValue attributeName="name" required="true" value="abcc"/>
<selectedValue attributeName="name" required="true" value="abillingInfo"/>
<selectedValue attributeName="name" required="true" value="acc"/>
<selectedValue attributeName="name" required="true" value="acompanies"/>
<selectedValue attributeName="name" required="true" value="adateCompleted"/>
<selectedValue attributeName="name" required="true" value="afolder"/>
<selectedValue attributeName="name" required="true" value="afromID"/>
<selectedValue attributeName="name" required="true" value="ahasAttachment"/>
<selectedValue attributeName="name" required="true" value="aimportance"/>
<selectedValue attributeName="name" required="true" value="aisRead"/>
<selectedValue attributeName="name" required="true" value="amail_ID"/>
<selectedValue attributeName="name" required="true" value="amaxRows"/>
<selectedValue attributeName="name" required="true" value="amaxRows"/>
<selectedValue attributeName="name" required="true" value="aMeetingUID"/>
<selectedValue attributeName="name" required="true" value="amessage"/>
<selectedValue attributeName="name" required="true" value="amessage"/>
<selectedValue attributeName="name" required="true" value="aMessageType"/>
<selectedValue attributeName="name" required="true" value="amileage"/>
<selectedValue attributeName="name" required="true" value="apercentCompleted"/>
<selectedValue attributeName="name" required="true" value="apriority"/>
<selectedValue attributeName="name" required="true" value="areminderDate"/>
<selectedValue attributeName="name" required="true" value="asensitivity"/>
<selectedValue attributeName="name" required="true" value="astatus"/>
<selectedValue attributeName="name" required="true" value="asubject"/>
<selectedValue attributeName="name" required="true" value="asubject"/>
<selectedValue attributeName="name" required="true" value="atoID"/>
<selectedValue attributeName="name" required="true" value="atotalWork"/>
<selectedValue attributeName="name" required="true" value="auid"/>
<selectedValue attributeName="name" required="true" value="aUID"/>
</triggers>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name,to</required>
<optional>from</optional>
</combination>
<combination attributename="name">
<required>from,name</required>
<optional>to</optional>
</combination>
<combination attributename="name">
<required>name,value</required>
<optional/>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="false" name="cfexchangemail"
single="true" xmlstyle="false">
<help><![CDATA[
Gets mail messages and attachments, deletes messages, and sets properties for messages on a Microsoft Exchange server.
The cfexchangemail tag performs mail actions on an Exchange server that you cannot do using the cfmail tag.
]]></help>
<return parameter="name" type="query"/>
<parameter isswitchattribute="true" name="action"
required="false" type="String">
<help><![CDATA[
The name to use for the JavaScript proxy class. (required)
]]></help>
<values>
<value option="get"/>
<value option="getAttachments"/>
<value option="getMeetingInfo"/>
<value option="delete"/>
<value option="deleteAttachments"/>
<value option="move"/>
<value option="set"/>
</values>
</parameter>
<parameter name="attachmentPath" required="false" type="String">
<help><![CDATA[
The file path of the directory in which to put the attachments.
If the directory does not exist, ColdFusion creates it.
If you omit this attribute, ColdFusion does not save any attachments.
If you specify a relative path, the path root is the ColdFusion temporary directory, which is returned by the GetTempDirectory function. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="getAttachments"/>
</triggers>
</parameter>
<parameter name="connection" required="false" type="variablename">
<help><![CDATA[
The name of the connection to the Exchange server, as specified in the cfexchangeconnection tag.
If you omit this attribute, and you specify cfexchangeconnection tag attributes in this tag, Coldfusion creates a temporary connection. (optional)
]]></help>
<values/>
</parameter>
<parameter name="folder" required="false" type="String">
<help><![CDATA[
The forward slash (/) delimited path, relative to the inbox, of the folder that contains the message or messages.
The cfechangemail tag looks in the specified folder only, and does not search subfolders.
If you omit this attribute, Exchange looks in the top level of the inbox. (optional)
]]></help>
<values/>
</parameter>
<parameter name="generateUniqueFilenames" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether to generate unique file names if multiple attachments have the same file names.
Case "yes": 3x myfile.txt -> myfile.txt, myfile1.txt, and myfile2.txt. (optional, default=no)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="getAttachments"/>
</triggers>
</parameter>
<parameter name="mailUID" required="false" type="String">
<help><![CDATA[
The case-sensitive UID of the mail message that contains the meeting request, response, or cancellation notfication.
You can use this attribute if there are multiple messages about a single meeting. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="getMessageInfo"/>
</triggers>
</parameter>
<parameter name="meetingUID" required="true" type="String">
<help><![CDATA[
The case-sensitive UID of the meeting for which you received the notification. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="getMessageInfo"/>
</triggers>
</parameter>
<parameter name="message" required="true" type="any">
<help><![CDATA[
A reference to a structure that contains the properties to be set and their values.
You must specify this attribute in number signs (#). (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="getMessageInfo"/>
</triggers>
</parameter>
<parameter name="name" required="true" returnVarType="query" type="String">
<help><![CDATA[
The name of the ColdFusion query variable that will contain the returned mail messages or information
about the attachments that were retrieved. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="get"/>
<selectedValue attributeName="action"
required="true" value="getAttachments"/>
</triggers>
</parameter>
<parameter name="UID" required="true" type="String">
<help><![CDATA[
The case-sensitive UIDs of the messages on which to perform the action.
For the delete action, this attribute can be a comma delimited list of UID values.
The getAttachments and set actions allow only a single UID value. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="delete"/>
<selectedValue attributeName="action"
required="true" value="getAttachments"/>
<selectedValue attributeName="action"
required="true" value="set"/>
</triggers>
</parameter>
<parameter name="destinationfolder" required="false" type="String">
<help><![CDATA[
The forward slash (/) delimited path, relative to the root of the mailbox, of the folder to which to move the message or messages.
]]></help>
</parameter>
<possiblecombinations>
<combination switchvalue="deleteattachments">
<required>uid</required>
<optional>connection,folder</optional>
</combination>
<combination switchvalue="set">
<required>message,uid</required>
<optional>connection,folder</optional>
</combination>
<combination switchvalue="get">
<required>name</required>
<optional>connection,folder</optional>
</combination>
<combination switchvalue="getmeetinginfo">
<required>meetinguid,name</required>
<optional>connection,mailuid</optional>
</combination>
<combination switchvalue="delete">
<required>uid</required>
<optional>connection,folder</optional>
</combination>
<combination switchvalue="move">
<required>destinationfolder</required>
<optional>connection,folder</optional>
</combination>
<combination switchvalue="getattachments">
<required>name,uid</required>
<optional>attachmentpath,connection,folder,generateuniquefilenames</optional>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="false" name="cfexchangetask"
single="true" xmlstyle="false">
<help><![CDATA[
Creates, deletes, modifies, and gets Microsoft Exchange tasks, and gets task attachments.
]]></help>
<return parameter="name" type="query"/>
<return parameter="result" type="String"/>
<parameter isswitchattribute="true" name="action"
required="false" type="String">
<help><![CDATA[
The action to take. Must be one of the following: create, delete, get, getAttachments, modify (optional)
]]></help>
<values>
<value option="create"/>
<value option="delete"/>
<value option="deleteAttachments"/>
<value option="get"/>
<value option="getAttachments"/>
<value option="modify"/>
</values>
</parameter>
<parameter name="attachmentPath" required="false" type="String">
<help><![CDATA[
The file path of the directory in which to put the attachments.
If the directory does not exist, ColdFusion creates it.
If you omit this attribute, ColdFusion does not save any attachments.
If you specify a relative path, the path root is the ColdFusion temporary directory, which is returned
by the GetTempDirectory function. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="getAttachments"/>
</triggers>
</parameter>
<parameter name="connection" required="false" type="variablename">
<help><![CDATA[
The name of the connection to the Exchange server, as specified in the cfexchangeconnection tag.
If you omit this attribute, and you specify cfexchangeconnection tag attributes in this tag,
Coldfusion creates a temporary connection. (optional)
]]></help>
<values/>
</parameter>
<parameter name="task" required="true" type="any">
<help><![CDATA[
A reference to the structure that contains the task properties to be set or changed and their values.
You must specify this attribute in number signs (#).
For more information on the event structure, see the Usage section. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="create"/>
<selectedValue attributeName="action"
required="true" value="modify"/>
</triggers>
</parameter>
<parameter name="name" required="true" returnVarType="query" type="String">
<help><![CDATA[
The name of the ColdFusion query variable that will contain the returned mail messages or information
about the attachments that were retrieved. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="get"/>
<selectedValue attributeName="action"
required="true" value="getAttachments"/>
</triggers>
</parameter>
<parameter name="results" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
(create) The name of a variable that will contain the UID of the task that is created.
You use this value in the uid attribute of other actions to identify the task to be acted on. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="create"/>
<selectedValue attributeName="action"
required="false" value="modify"/>
</triggers>
</parameter>
<parameter name="uid" required="true" type="String">
<help><![CDATA[
A case-sensitive Exchange UID value that uniquely identifies the tasks on which to perform the action.
For the delete action, this attribute can be a comma delimited list of UID values.
The getAttachments and modify action allow only a single UID value. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="getAttachments"/>
<selectedValue attributeName="action"
required="true" value="delete"/>
<selectedValue attributeName="action"
required="true" value="modify"/>
</triggers>
</parameter>
<parameter name="result" required="false" type="String">
<help><![CDATA[
The name of a variable that contains the UID of the task that is created. You use this value in the uid attribute of other actions to identify the task to be acted on.
]]></help>
</parameter>
<possiblecombinations>
<combination switchvalue="deleteattachments">
<required>uid</required>
<optional>connection</optional>
</combination>
<combination switchvalue="modify">
<required>task,uid</required>
<optional>connection</optional>
</combination>
<combination switchvalue="create">
<required>task</required>
<optional>connection,result</optional>
</combination>
<combination switchvalue="get">
<required>name</required>
<optional>connection</optional>
</combination>
<combination switchvalue="delete">
<required>uid</required>
<optional>connection</optional>
</combination>
<combination switchvalue="getattachments">
<required>name,uid</required>
<optional>attachmentpath,connection</optional>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="false" name="cffeed"
single="true" xmlstyle="false">
<help><![CDATA[
Reads or creates an RSS or Atom syndication feed.
This tag can read RSS versions 0.90, 0.91, 0.92, 0.93, 0.94, 1.0, and 2.0, and Atom 0.3 or 1.0.
It can create RSS 2.0 or Atom 1.0 feeds.
]]></help>
<return parameter="name" type="Struct"/>
<return parameter="properties" type="Struct"/>
<return parameter="query" type="query"/>
<return parameter="xmlvar" type="variablename"/>
<parameter isswitchattribute="true" name="action"
required="false" type="any">
<help><![CDATA[
The name to use for the JavaScript proxy class.
The action to take, one of the following values:
"create" Creates an RSS 2.0 or Atom 1.0 feed XML document and saves it in a variable, writes it to a file, or both.
"read" Parses an RSS or Atom feed from a URL or an XML file and saves it in a structure or query.
You can also get query metadata in a separate structure. (optional, default= read)
]]></help>
<values>
<value option="create"/>
<value option="read"/>
</values>
</parameter>
<parameter name="columnMap" required="false" type="any">
<help><![CDATA[
Used only for the create action with a query attribute.
A structure specifying a mapping between the names of the columns in the object specified by the query attribute
and the columns of the ColdFusion feed format, as described in the Query attribute section.
The key for each field must be a column name listed in the Query columns section. The value of the field must be
the name of the corresponding column in the query object used as input to the create action. (optional)
]]></help>
<values/>
</parameter>
<parameter name="enclosureDir" required="false" type="String">
<help><![CDATA[
Used only for the read action.
Path to the directory in which to save any enclosures that are available in the feed being read.
The path can be absolute or relative to the CFML file.
If the directory does not exist, ColdFusion generates an error.
If you omit this attribute, ColdFusion does not save enclosures.
To specify the directory that contains the current page, set this attribute to .(period). (optional)
]]></help>
<values/>
</parameter>
<parameter name="ignoreEnclosureError" required="false" type="Boolean">
<help><![CDATA[
If this attribute is true, ColdFusion attempts to save all enclosures.
If it encounters an error downloading one enclosure, it continues downloading other enclosures and writes the
error information in the server log.
If this attribute is false, ColdFusion stops downloading all enclosures and generates an error when it encounters
an error downloading an enclosure.
Note: Enclosure errors can occur if the specified enclosure is of a type that the web server does not allow to be
downloaded. (optional, default=false)
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="name" required="false" returnVarType="Struct" type="String">
<help><![CDATA[
A structure that contains complete feed data:
The output of a read action.
The input definition of the feed to create.
This structure contains complete feed information.
When you specify the name attribute for a create action, you must put it in pound signs (#). (optional)
]]></help>
<values/>
</parameter>
<parameter name="outputFile" required="false" type="String">
<help><![CDATA[
Path of the file in which to write the feed as XML text.
The path can be absolute, or relative to the CFML file. (optional)
]]></help>
<values/>
</parameter>
<parameter name="overwrite" required="false" type="Boolean">
<help><![CDATA[
Whether to overwrite the XML feed file if it already exists.
If you do not set this attribute to true and the cffeed tag tries to write to a file that exists, ColdFusion
generates an error. (optional, default=false)
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="overwriteEnclosure" required="false" type="Boolean">
<help><![CDATA[
Used only for the read action.
Whether to overwrite files in the enclosure directory if they already exist.
If you do not set this attribute to true and the cffeed tag tries to write to a file that exists, ColdFusion
generates an error. (optional, default=false)
]]></help>
<values/>
</parameter>
<parameter name="properties" returnVarType="Struct" required="false" type="String">
<help><![CDATA[
A structure containing the feed metadata, the information about the entire feed.
Can contain either of the following:
The output of a read action.
Input to a create action.
The properties and query attributes combined provide complete feed information.
When you specify the properties attribute for a create action, you must put it in pound signs (#) (optional)
]]></help>
<values/>
</parameter>
<parameter name="query" required="false" returnVarType="query" type="String">
<help><![CDATA[
A query object containing the Atom entries or RSS items in the feed. Can contain either of the following:
The output of a read action.
Input to a create action.
The properties and query attributes combined provide complete feed information.
When you specify the query attribute for a create action, you must put it in pound signs (#) (optional)
]]></help>
<values/>
</parameter>
<parameter name="source" required="false" type="String">
<help><![CDATA[
Used only for the read action.
The URL of the feed or the path to the XML file that contains the feed contents.
A path can be absolute, or relative to the CFML file. (required)
]]></help>
<values/>
</parameter>
<parameter name="timeout" required="false" type="Numeric">
<help><![CDATA[
The number of seconds to wait for a response from the feed source. A value of 0 specifies that the request does not time out.
]]></help>
</parameter>
<parameter name="proxyServer" required="false" type="String">
<help><![CDATA[
Host name or IP address of a proxy server to which to send the request.
]]></help>
</parameter>
<parameter name="xmlvar" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
A variable in which to save the read or created feed as XML text.
]]></help>
</parameter>
<parameter name="proxyPort" required="false" type="Numeric">
<help><![CDATA[
The port to connect to on the proxy server.
]]></help>
</parameter>
<parameter name="proxyPassword" required="false" type="String">
<help><![CDATA[
Password required by the proxy server.
]]></help>
</parameter>
<parameter name="userAgent" required="false" type="String">
<help><![CDATA[
Text to put in the HTTP User-Agent request header field. Used to identify the request client software.
]]></help>
</parameter>
<parameter name="proxyUser" required="false" type="String">
<help><![CDATA[
User name to provide to the proxy server.
]]></help>
</parameter>
<parameter name="escapeChars" required="false" type="boolean">
<help><![CDATA[
Escapes invalid utf8 chars when set to true
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="create">
<required/>
<optional>columnmap,name,outputfile,overwrite,properties,query,source,useragent,xmlvar,escapeChars</optional>
</combination>
<combination switchvalue="read">
<required>source</required>
<optional>action,enclosuredir,ignoreenclosureerror,name,outputfile,overwrite,overwriteenclosure,properties,proxypassword,proxyport,proxyserver,proxyuser,query,timeout,useragent,xmlvar</optional>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="false" name="cfimage"
single="true" xmlstyle="false">
<help><![CDATA[
Creates a ColdFusion image that can be manipulated by using Image functions.
You can use the cfimage tag to perform common image manipulation operations as a shortcut to Image functions.
You can use the cfimage tag independently or in conjunction with Image functions.
]]></help>
<return parameter="name" type="variablename"/>
<parameter isswitchattribute="true" name="action"
required="false" type="String">
<help><![CDATA[
The action to take. Must be one of the following:
border
captcha
convert
info
read
resize
rotate
write
writeToBrowser
You do not need to specify the default action, read, explicitly. (optional, default=read)
]]></help>
<values>
<value option="border"/>
<value option="captcha"/>
<value option="convert"/>
<value option="info"/>
<value option="read"/>
<value option="resize"/>
<value option="rotate"/>
<value option="write"/>
<value option="writeToBrowser"/>
</values>
</parameter>
<parameter name="angle" required="false" type="Numeric">
<help><![CDATA[
Angle in degrees to rotate the image.
You must specify an integer for the value. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="rotate"/>
</triggers>
</parameter>
<parameter name="color" required="false" type="String">
<help><![CDATA[
(border) Border color.
Hexadecimal value or supported named color.
For a hexadecimal value, use the form "##xxxxxx" or "xxxxxx". (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="border"/>
</triggers>
</parameter>
<parameter name="destination" required="false" type="String">
<help><![CDATA[
Absolute or relative pathname where the image output is written.
The image format is determined by the file extension.
The convert and write actions require a destination.
The border, captcha, resize, and rotate actions require either a name attribute or a destination attribute.
You can specify both.
Scorpio supports only CAPTCHA images in PNG format.
If you do not enter a destination, the CAPTCHA image is placed inline in the HTML output and displayed in the web browser. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="border"/>
<selectedValue attributeName="action"
required="false" value="captcha"/>
<selectedValue attributeName="action"
required="false" value="convert"/>
<selectedValue attributeName="action"
required="false" value="resize"/>
<selectedValue attributeName="action"
required="false" value="rotate"/>
<selectedValue attributeName="action"
required="false" value="write"/>
</triggers>
</parameter>
<parameter name="difficulty" required="false" type="String">
<help><![CDATA[
Level of complexity of the CAPTCHA text.
Specify one of the following levels of text distortion:
high
medium
low (optional, default=low)
]]></help>
<values>
<value option="high"/>
<value option="medium"/>
<value option="low"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="captcha"/>
</triggers>
</parameter>
<parameter name="fontSize" required="false" type="Numeric">
<help><![CDATA[
Font size of the text in the CAPTCHA image.
The value must be an integer. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="captcha"/>
</triggers>
</parameter>
<parameter name="format" required="false" type="String">
<help><![CDATA[
Format of the image displayed in the browser.
If you do not specify a format, the image is displayed in PNG format.
You cannot display a GIF image in a browser.
GIF images are displayed in PNG format. (optional, Default=PNG)
]]></help>
<values>
<value option="PNG"/>
<value option="jpg"/>
<value option="jpeg"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="writeToBrowser"/>
</triggers>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
Height in pixels of the image.
For the resize attribute, you also can specify the height as a percentage (an integer followed by the "%" symbol).
The value must be an integer. (optional)
]]></help>
<values/>
</parameter>
<parameter name="isBase64" required="false" type="Boolean">
<help><![CDATA[
Specifies whether the source is a Base64 string.
The isBase64 values are:
yes: the source is a Base64 string.
no: the source is not a Base64 string. (optional, default=no)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="border"/>
<selectedValue attributeName="action"
required="false" value="convert"/>
<selectedValue attributeName="action"
required="false" value="info"/>
<selectedValue attributeName="action"
required="false" value="read"/>
<selectedValue attributeName="action"
required="false" value="resize"/>
<selectedValue attributeName="action"
required="false" value="rotate"/>
<selectedValue attributeName="action"
required="false" value="write"/>
<selectedValue attributeName="action"
required="false" value="writeToBrowser"/>
</triggers>
</parameter>
<parameter name="name" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
Name of the ColdFusion image variable to create.
The read action requires name attribute.
The border, resize, and rotate options require a name attribute or a destination attribute.
You can specify both. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="border"/>
<selectedValue attributeName="action"
required="false" value="convert"/>
<selectedValue attributeName="action"
required="false" value="read"/>
<selectedValue attributeName="action"
required="false" value="resize"/>
<selectedValue attributeName="action"
required="false" value="rotate"/>
</triggers>
</parameter>
<parameter name="overwrite" required="false" type="Boolean">
<help><![CDATA[
Valid only if the destination attribute is specified. The overwrite values are:
yes: overwrites the destination file.
no: does not overwrite the destination file.
If the destination file already exists, ColdFusion generates an error if the overwrite option is not set to yes. (optional, default=no)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="border"/>
<selectedValue attributeName="action"
required="false" value="convert"/>
<selectedValue attributeName="action"
required="false" value="captcha"/>
<selectedValue attributeName="action"
required="false" value="convert"/>
<selectedValue attributeName="action"
required="false" value="read"/>
<selectedValue attributeName="action"
required="false" value="resize"/>
<selectedValue attributeName="action"
required="false" value="rotate"/>
<selectedValue attributeName="action"
required="false" value="write"/>
</triggers>
</parameter>
<parameter name="quality" required="false" type="Numeric">
<help><![CDATA[
Quality of the JPEG destination file.
Applies only to files with an extension of JPG or JPEG.
Valid values are fractions that range from 0 through 1
(the lower the number, the lower the quality). (optional, default=0.75)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="write"/>
</triggers>
</parameter>
<parameter name="source" required="false" type="Any">
<help><![CDATA[
URL of the source image; for example, "http://www.google.com/ images/logo.gif"
Absolute or relative pathname of the source image; for example, "c:\wwwroot\images\logo.jpg"
ColdFusion image variable containing another image, BLOB, or byte array; for example, "#myImage#"
Base64 string; for example, "data:image/jpg;base64,/9j/ 4AAQSkZJRgABAQA.............." (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="border"/>
<selectedValue attributeName="action"
required="true" value="convert"/>
<selectedValue attributeName="action"
required="true" value="info"/>
<selectedValue attributeName="action"
required="true" value="read"/>
<selectedValue attributeName="action"
required="true" value="resize"/>
<selectedValue attributeName="action"
required="true" value="rotate"/>
<selectedValue attributeName="action"
required="true" value="write"/>
<selectedValue attributeName="action"
required="true" value="writeToBrowser"/>
</triggers>
</parameter>
<parameter name="structName" required="false" type="String">
<help><![CDATA[
() Name of the ColdFusion structure to be created. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="info"/>
</triggers>
</parameter>
<parameter name="text" required="false" type="String">
<help><![CDATA[
Text string displayed in the CAPTCHA image.
Use capital letters for better readability. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="captcha"/>
</triggers>
</parameter>
<parameter name="thickness" required="false" type="Numeric">
<help><![CDATA[
Border thickness in pixels.
The border is added to the outside edge of the source image,
increasing the image area accordingly.
The value must be an integer. (optional, default=1)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="border"/>
</triggers>
</parameter>
<parameter name="width" required="false" type="String">
<help><![CDATA[
Width in pixels of the image.
For resize, you also can specify the width as a percentage
(an integer followed by the "%" symbol).
The value must be an integer. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="captcha"/>
<selectedValue attributeName="action"
required="true" value="resize"/>
</triggers>
</parameter>
<parameter name="fonts" required="false" type="String">
<help><![CDATA[
One or more valid fonts to use for the CAPTCHA text. Separate multiple fonts with commas. ColdFusion supports only the system fonts that the JDK can recognize.
]]></help>
</parameter>
<possiblecombinations>
<combination switchvalue="writetobrowser">
<required>source</required>
<optional>format,isbase64</optional>
</combination>
<combination switchvalue="convert">
<required>destination,source</required>
<optional>isbase64,name,overwrite</optional>
</combination>
<combination switchvalue="info">
<required>source,structname</required>
<optional>isbase64</optional>
</combination>
<combination switchvalue="write">
<required>destination,source</required>
<optional>isbase64,overwrite,quality</optional>
</combination>
<combination switchvalue="captcha">
<required>text</required>
<optional>destination,difficulty,fonts,fontsize,overwrite,height,width</optional>
</combination>
<combination switchvalue="border">
<required>source</required>
<optional>color,destination,isbase64,name,overwrite,thickness</optional>
</combination>
<combination switchvalue="resize">
<required>height,source,width</required>
<optional>destination,isbase64,name,overwrite</optional>
</combination>
<combination switchvalue="rotate">
<required>angle,source</required>
<optional>destination,isbase64,name,overwrite</optional>
</combination>
<combination switchvalue="read">
<required>name,source</required>
<optional>action,isbase64</optional>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="true" canHaveAttributeCollection="false" name="cfinterface"
single="false" xmlstyle="false">
<help><![CDATA[
Defines an interface that consists of a set of signatures for functions.
The interface does not include the full function definitions;
instead, you implement the functions in a CFC.
The interfaces that you define by using this tag can make up
the structure of a reusable application framework.
]]></help>
<parameter name="displayName" required="false" type="String">
<help><![CDATA[
A value to be displayed when using introspection to
show a descriptive name for the interface. (optional)
]]></help>
<values/>
</parameter>
<parameter name="extends" required="false" type="String">
<help><![CDATA[
A comma delimited list of one or more interfaces that this interface extends.
Any CFC that implements an interface must also implement all the functions
in the interfaces specified by this property.
If an interface extends another interface, and the child interface specifies
a function with the same name as one in the parent interface, both functions
must have the same attribues; otherwise ColdFusion generates an error. (optional)
]]></help>
<values/>
</parameter>
<parameter name="hint" required="false" type="String">
<help><![CDATA[
Text to be displayed when using introspection to show information about the interface.
The hint attribute value follows the syntax line in the function description. (optional)
]]></help>
<values/>
</parameter>
</tag>
<tag creator="8" endtagrequired="false" name="cfpdf"
single="true" xmlstyle="false">
<help><![CDATA[
Manipulates existing PDF documents. The following list describes some of the
tasks you can perform with the cfpdf tag:
Merge several PDF documents into one PDF document.
Extract pages from multiple PDF documents and generate a new PDF document.
Linearize multipage PDF documents for faster display.
Encrypt or decrypt PDF files for security.
]]></help>
<return parameter="name" type="variablename"/>
<parameter isswitchattribute="true" name="action"
required="false" type="String">
<help><![CDATA[
The action to take. Must be one of the following:
addwatermark
deletepages
getinfo
merge
protect
read
removewatermark
setinfo
write
(required)
]]></help>
<values>
<value option="addwatermark"/>
<value option="deletepages"/>
<value option="getinfo"/>
<value option="merge"/>
<value option="protect"/>
<value option="processddx"/>
<value option="read"/>
<value option="removewatermark"/>
<value option="setinfo"/>
<value option="thumbnail"/>
<value option="write"/>
<value option="extracttext"/>
<value option="extractimage"/>
<value option="addheader"/>
<value option="addfooter"/>
<value option="removeheaderfooter"/>
<value option="optimize"/>
<value option="transform"/>
</values>
</parameter>
<parameter name="ascending" required="false" type="Boolean">
<help><![CDATA[
Order in which the PDF files are sorted:
yes: files are sorted in ascending order
no: files are sorted in descending order (optional, default=no)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="merge"/>
</triggers>
</parameter>
<parameter name="copyfrom" required="false" type="String">
<help><![CDATA[
The filename of the PDF document from which to copy the watermark (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="addwatermark"/>
</triggers>
</parameter>
<parameter name="destination" required="false" type="String">
<help><![CDATA[
The pathname of the modified PDF document.
If the destination file exists, you must set the overwrite attribute to yes.
If the destination file does not exist, ColdFusion creates it as long as
the parent directory exists. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="addwatermark"/>
<selectedValue attributeName="action"
required="true" value="deletepages"/>
<selectedValue attributeName="action"
required="false" value="merge"/>
<selectedValue attributeName="action"
required="false" value="protect"/>
<selectedValue attributeName="action"
required="true" value="removewatermark"/>
<selectedValue attributeName="action"
required="true" value="setinfo"/>
<selectedValue attributeName="action"
required="true" value="write"/>
</triggers>
</parameter>
<parameter name="directory" required="false" type="String">
<help><![CDATA[
Specify the directory of the PDF documents to merge.
You must specify either the directory or the source.
If you specify the directory, you must also specify the order. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="merge"/>
</triggers>
</parameter>
<parameter name="encrypt" required="false" type="String">
<help><![CDATA[
Specify the type of encryption used on the source PDF document:
RC4_40, RC4_128M, AES_128, none (optional)
]]></help>
<values>
<value option="RC4_40"/>
<value option="RC4_128"/>
<value option="RC4_128M"/>
<value option="AES_128"/>
<value option="none"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="protect"/>
</triggers>
</parameter>
<parameter name="flatten" required="false" type="Boolean">
<help><![CDATA[
Specify whether the output file is flattened:
yes: the formatting is removed and the file is flattened
no: the format of the source PDF is maintained in the output file. (optional,default=no)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="write"/>
</triggers>
</parameter>
<parameter name="foreground" required="false" type="Boolean">
<help><![CDATA[
Specify whether the watermark is placed in the foreground of the PDF document:
yes: the watermark appears in the foreground
no: the watermark appears in the background (optional, default=no)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="addwatermark"/>
</triggers>
</parameter>
<parameter name="image" required="false" type="String">
<help><![CDATA[
Specify the image used as a watermark.
You can specify a filename or a ColdFusion image variable. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="addwatermark"/>
</triggers>
</parameter>
<parameter name="info" required="false" type="String">
<help><![CDATA[
Specify the structure variable for relevant information, for example, #infoStruct#.
ColdFusion ignores read only information, such as the creation date, application used to create
the PDF document, and encryption parameters. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="setInfo"/>
</triggers>
</parameter>
<parameter name="isBase64" required="false" type="Boolean">
<help><![CDATA[
Specify whether the image used a watermark is in Base64 format:
yes: the image is in Base64 format
no: the image is not in Base64 format (optional, default=no)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="addwatermark"/>
</triggers>
</parameter>
<parameter name="keepbookmark" required="false" type="Boolean">
<help><![CDATA[
Specify whether bookmarks from the source PDF
documents are retained in the merged document:
yes: the bookmarks are retained
no: the bookmarks are removed (optional, default=no)
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="merge"/>
</triggers>
</parameter>
<parameter name="name" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
Specify the PDF document variable name, for example, myPDFdoc.
If the source is a PDF document variable, you cannot specify the
name attribute again; you can write the modified PDF document
to the destination. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="addwatermark"/>
<selectedValue attributeName="action"
required="false" value="deletepages"/>
<selectedValue attributeName="action"
required="true" value="getinfo"/>
<selectedValue attributeName="action"
required="false" value="merge"/>
<selectedValue attributeName="action"
required="false" value="protect"/>
<selectedValue attributeName="action"
required="true" value="read"/>
<selectedValue attributeName="action"
required="false" value="removewatemark"/>
<selectedValue attributeName="action"
required="false" value="write"/>
</triggers>
</parameter>
<parameter name="newOwnerPassword" required="false" type="String">
<help><![CDATA[
Specify the password for the owner of the PDF document. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="protect"/>
</triggers>
</parameter>
<parameter name="newUserPassword" required="false" type="String">
<help><![CDATA[
Specify the password for the user of the PDF document. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="protect"/>
</triggers>
</parameter>
<parameter name="opacity" required="false" type="String">
<help><![CDATA[
Specify the opacity of the watermark.
Valid values are integers in the range 0 (transparent)
through 10 (opaque). (optional, default=3)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="addwatermark"/>
</triggers>
</parameter>
<parameter name="order" required="false" type="String">
<help><![CDATA[
Specify the order in which the PDF documents
in the directory are merged:
name: orders the documents alphabetically
time: orders the documents by timestamp (required)
]]></help>
<values>
<value option="name"/>
<value option="time"/>
</values>
<triggers>
<selectedValue attributeName="directory" required="true"/>
</triggers>
</parameter>
<parameter name="overwrite" required="false" type="String">
<help><![CDATA[
Specify whether to overwrite the destination file:
yes: overwrites the destination file
no: does not overwrite the destination file (optional)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="addwatermark"/>
<selectedValue attributeName="action"
required="false" value="deletepages"/>
<selectedValue attributeName="action"
required="false" value="merge"/>
<selectedValue attributeName="action"
required="false" value="protect"/>
<selectedValue attributeName="action"
required="false" value="removewatermark"/>
<selectedValue attributeName="action"
required="false" value="setinfo"/>
<selectedValue attributeName="action"
required="false" value="write"/>
</triggers>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Specify the owner or user password of the source PDF document, if it exists. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="addwatermark"/>
<selectedValue attributeName="action"
required="false" value="deletepages"/>
<selectedValue attributeName="action"
required="false" value="getinfo"/>
<selectedValue attributeName="action"
required="false" value="merge"/>
<selectedValue attributeName="action"
required="false" value="read"/>
<selectedValue attributeName="action"
required="false" value="removewatermark"/>
<selectedValue attributeName="action"
required="false" value="setinfo"/>
<selectedValue attributeName="action"
required="false" value="write"/>
</triggers>
</parameter>
<parameter name="permissions" required="false" type="String">
<help><![CDATA[
Specify the type of permissions on the PDF document:
AllowPrintHigh
AllowPrintLow
AllowModify
AllowCopy
AllowAdd
AllowSecure
AllowModifyAnnotations
AllowExtract
AllowFillIn
all
none
Except for all or none, you can specify a
commaseparated list of permissions. (optional)
]]></help>
<values>
<value option="all"/>
<value option="allowassembly"/>
<value option="allowcopy"/>
<value option="AllowDegradedPrinting"/>
<value option="AllowFillIn"/>
<value option="AllowModifyAnnotations"/>
<value option="AllowModifyContents"/>
<value option="AllowPrinting"/>
<value option="AllowScreenReaders"/>
<value option="AllowSecure"/>
<value option="none"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="protect"/>
</triggers>
</parameter>
<parameter name="position" required="false" type="String">
<help><![CDATA[
Specify the position on the page where
the watermark is placed. The position represents the
top-left corner of the watermark.
Specify the x and y coordinates; for example 50,30. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="addwatermark"/>
</triggers>
</parameter>
<parameter name="rotation" required="false" type="Numeric">
<help><![CDATA[
Specify the degree of rotation of
the watermark image on the page; for example, 30. (optional)
]]></help>
<values>
<values option="0" />
<values option="90" />
<values option="180" />
<values option="270" />
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="addwatermark"/>
</triggers>
</parameter>
<parameter name="showonprint" required="false" type="String">
<help><![CDATA[
Specify whether the watermark is printed with
the PDF document:
yes: the watermark is printed with the PDF document
no: the watermark is not printed with the PDF document (optional)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="addwatermark"/>
</triggers>
</parameter>
<parameter name="source" required="false" type="String">
<help><![CDATA[
Specify the source. The source can be:
The pathname to a PDF document; for example, c:\work\myPDF.pdf
A PDF document variable in memory that is generated by the
cfdocument tag or the cfpdf tag; for example, #myPDFdoc#
The binary content of PDF document variable. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="removewatermark"/>
</triggers>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
Specify the type to remove from the source PDF document:
attachment
bookmark
watermark (optional)
]]></help>
<values>
<value option="string"/>
<value option="xml"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="true" value="removewatermark"/>
</triggers>
</parameter>
<parameter name="version" required="false" type="String">
<help><![CDATA[
(write) Specify the version of the PDF document to write.
Valid values are:
1.1
1.2
1.3
1.4
1.5
1.6 (optional)
]]></help>
<values>
<value option="1.1"/>
<value option="1.2"/>
<value option="1.3"/>
<value option="1.4"/>
<value option="1.5"/>
<value option="1.6"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="write"/>
</triggers>
</parameter>
<parameter name="transparent" required="false" type="Boolean">
<help><![CDATA[
Specifies whether the image background is transparent or opaque: foormat=png only
* yes: the background is transparent.
* no: the background is opaque.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="resolution" required="false" type="String">
<help><![CDATA[
Image quality used to generate thumbnail images:
* high: use high resolution (uses more memory).
* low: use low resolution.
]]></help>
</parameter>
<parameter name="stoponerror" required="false" type="Boolean">
<help><![CDATA[
Valid only if the directory attribute is specified. If the specified directory contains files other then ColdFusion-readable PDF files, ColdFusion either stops merge process or continues.
* yes: stops the merge process if invalid PDF files exist in the specified directory.
* no: continues the merge process even if invalid files exist in the specified directory.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="inputfiles" required="false" type="Struct">
<help><![CDATA[
Structure that maps the PDF source files to the input variables in the DDX file, or a string of elements and their pathname.
]]></help>
</parameter>
<parameter name="scale" required="false" type="Numeric">
<help><![CDATA[
Size of the thumbnail relative to the source page. The value represents a percentage from 1 through 100.
]]></help>
</parameter>
<parameter name="imageprefix" required="false" type="String">
<help><![CDATA[
Prefix used for each image thumbnail file generated. The image filenames use the format: imagePrefix_page_n.format.
]]></help>
</parameter>
<parameter name="outputfiles" required="false" type="Struct">
<help><![CDATA[
Structure that contains the output files in the DDX file or string as keys and the pathname to the result file as the value.
]]></help>
</parameter>
<parameter name="pages" required="false" type="String">
<help><![CDATA[
Page or pages in the source PDF document on which to perform the action. You can specify multiple pages and page ranges as follows: "1,6-9,56-89,100, 110-120".
]]></help>
</parameter>
<parameter name="ddxfile" required="false" type="String">
<help><![CDATA[
Owner or user password of the source PDF document, if the document is password-protected.
]]></help>
</parameter>
<parameter name="saveoption" required="false" type="String">
<help><![CDATA[
Save options for the PDF output:
* full: normal save (default)
* incremental: required to save modifications to a signed PDF document.
* linear: for faster display.
]]></help>
<values default="full">
<value option="full"/>
<value option="incremental"/>
<value option="linear"/>
</values>
</parameter>
<parameter name="format" required="false" type="String">
<help><![CDATA[
File type of thumbnail image output:
* jpg
* tiff
* png
]]></help>
<values default="jpg">
<value option="jpg"/>
<value option="tiff"/>
<value option="png"/>
</values>
</parameter>
<parameter name="hires" required="false" type="Boolean">
<help><![CDATA[
Sets a high resolution for the thumbnail if set to yes.
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="maxScale" required="false" type="Numeric">
<help><![CDATA[
Specifies the maximum scale of the thumbnail
]]></help>
</parameter>
<parameter name="maxBreadth" required="false" type="Numeric">
<help><![CDATA[
Specifies maximum width of the thumbnail
]]></help>
</parameter>
<parameter name="maxLength" required="false" type="Numeric">
<help><![CDATA[
Specifies the maximum length of the thumbnail
]]></help>
</parameter>
<parameter name="compressTIFFs" required="false" type="Boolean">
<help><![CDATA[
Compress thumbnail which are in TIFF format.
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="overridepage" required="false" type="Boolean">
<help><![CDATA[
Specify whether to override page or not
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="package" required="false" type="Boolean">
<help><![CDATA[
Create PDF packages
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="hScale" required="false" type="Numeric">
<help><![CDATA[
Horizontal scale of the image to be modified. Valid values are hscale<1.
]]></help>
</parameter>
<parameter name="vScale" required="false" type="Numeric">
<help><![CDATA[
Vertical scale of the image to be modified. Valid values are vsacle<1.
]]></help>
</parameter>
<parameter name="noBookMarks" required="false" type="Boolean">
<help><![CDATA[
Remove bookmarks from PDF document
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="noAttachments" required="false" type="Boolean">
<help><![CDATA[
Removes all attachments from PDF documents.
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="noComments" required="false" type="Boolean">
<help><![CDATA[
Remove comments from PDF document
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="noJavaScripts" required="false" type="Boolean">
<help><![CDATA[
Remove all document level JavaScript actions
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="noLinks" required="false" type="Boolean">
<help><![CDATA[
Remove external cross-references
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="noMetadata" required="false" type="Boolean">
<help><![CDATA[
Remove document information and metadata
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="noThumbnails" required="false" type="Boolean">
<help><![CDATA[
Remove embedded page thumbnails
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="noFonts" required="false" type="Boolean">
<help><![CDATA[
Remove font styling
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="algo" required="false" type="String">
<help><![CDATA[
Specifies the algorithm for image downsampling.
]]></help>
<values>
<value option="Bicubic" />
<value option="Bilinear" />
<value option="Nearest_Neighbour" />
</values>
</parameter>
<parameter name="topMargin" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="leftMargin" required="false" type="Numeric">
<help><![CDATA[
Specifies the value of the leftMargin
]]></help>
</parameter>
<parameter name="rightMargin" required="false" type="Numeric">
<help><![CDATA[
Specifies the value of the rightMargin
]]></help>
</parameter>
<parameter name="bottomMargin" required="false" type="Numeric">
<help><![CDATA[
Specifies the value of the bottomMargin
]]></help>
</parameter>
<parameter name="numberFormat" required="false" type="String">
<help><![CDATA[
Specify the numbering format for PDF pages in the footer.
]]></help>
<values>
<value option="NUMERIC" />
<value option="LOWERCASEROMAN" />
<value option="UPPERCASEROMAN" />
</values>
</parameter>
<parameter name="align" required="false" type="String">
<help><![CDATA[
Aligns the header and footer in PDF.
]]></help>
<values>
<value option="right" />
<value option="left" />
<value option="center" />
</values>
</parameter>
<parameter name="honourspaces" required="false" type="Boolean">
<help><![CDATA[
Set this option to "true" if you need characters to be converted to spaces.
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="addQuads" required="false" type="Boolean">
<help><![CDATA[
Add the position or quadrants of the thumbnail
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="text" required="false" type="String">
<help><![CDATA[
Specify Text Value
]]></help>
<values>
<value option="_PAGELABEL" />
<value option="_LASTPAGELABEL" />
<value option="_PAGENUMBER" />
<value option="_LASTPAGENUMBER" />
</values>
</parameter>
<parameter name="useStructure" required="false" type="Boolean">
<help><![CDATA[
Specify whether to use structure or not
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="jpgdpi" required="false" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="encodeAll" required="false" type="Boolean">
<help><![CDATA[
Encode streams that are not encoded to optimize page content
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="thumbnail">
<required/>
<optional>compresstiffs,destination,directory,format,hires,imageprefix,jpgdpi,maxbreadth,maxlength,maxscale,overridepage,overwrite,pages,password,resolution,scale,source,stoponerror,transparent</optional>
</combination>
<combination switchvalue="write">
<required>destination,source</required>
<optional>flatten,overwrite,password,saveoption,version,name,encodeAll</optional>
</combination>
<combination switchvalue="protect">
<required>source</required>
<optional>destination,encrypt,name,newownerpassword,newuserpassword,overwrite,password,permissions</optional>
</combination>
<combination switchvalue="deletepages">
<required>pages,source</required>
<optional>destination,name,overwrite,password</optional>
</combination>
<combination switchvalue="addwatermark">
<required>source</required>
<optional>copyfrom,destination,foreground,image,isbase64,name,opacity,overwrite,pages,password,position,rotation,showonprint</optional>
</combination>
<combination switchvalue="processddx">
<required>ddxfile,inputfiles,name,outputfiles</required>
<optional>action</optional>
</combination>
<combination switchvalue="setinfo">
<required>info,source</required>
<optional>destination,overwrite,password</optional>
</combination>
<combination switchvalue="getinfo">
<required>name,source</required>
<optional>password</optional>
</combination>
<combination switchvalue="merge">
<required/>
<optional>package,ascending,destination,directory,keepbookmark,name,order,overwrite,pages,password,source,stoponerror</optional>
</combination>
<combination switchvalue="read">
<required>name,source</required>
<optional>password</optional>
</combination>
<combination switchvalue="removewatermark">
<required>source</required>
<optional>destination,name,overwrite,pages,password,stoponerror</optional>
</combination>
<combination switchvalue="extracttext">
<required>source</required>
<optional>addquads,destination,honourspaces,name,overwrite,pages,password,type,usestructure</optional>
</combination>
<combination switchvalue="addheader">
<required>source</required>
<optional>align,destination,image,isbase64,leftmargin,name,numberformat,opacity,overwrite,pages,password,rightmargin,showonprint,text,topmargin</optional>
</combination>
<combination switchvalue="addfooter">
<required>source</required>
<optional>align,bottommargin,destination,image,isbase64,leftmargin,name,numberformat,opacity,overwrite,pages,password,rightmargin,showonprint,text</optional>
</combination>
<combination switchvalue="removeheaderfooter">
<required>source</required>
<optional>destination,name,overwrite,pages,password</optional>
</combination>
<combination switchvalue="optimize">
<required>source</required>
<optional>algo,destination,hscale,name,noattachments,nobookmarks,nocomments,nofonts,nojavascripts,nolinks,nometadata,nothumbnails,overwrite,pages,password,vscale</optional>
</combination>
<combination switchvalue="transform">
<required>source</required>
<optional>destination,hscale,name,overwrite,pages,password,position,rotation,vscale</optional>
</combination>
<combination switchvalue="extractimage">
<required>source</required>
<optional>destination,format,imageprefix,overwrite,pages,password</optional>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="true" name="cfpdfform"
single="false" xmlstyle="true">
<help><![CDATA[
Manipulates existing Adobe Acrobat forms and Adobe LiveCycle forms.
The following list describes some of the tasks you can perform with the cfpdfform tag:
Embed an interactive Acrobat form or LiveCycle form within a PDF document.
You use the cfpdfform tag to embed the PDF form within a cfdocument tag.
Render an existing Acrobat form or LiveCycle form. This includes prefilling
fields from a database or an XML data file and processing form data submitted
via HTTP post or PDF format.
Extract or prefill values in stored PDF forms and save the output to a file
or use it to update a data source.
]]></help>
<return parameter="result" type="Struct"/>
<parameter isswitchattribute="true" name="action"
required="true" type="String">
<help><![CDATA[
The action to perform on the source:
populate
read (required)
]]></help>
<values>
<value option="populate"/>
<value option="read"/>
</values>
</parameter>
<parameter name="datafile" required="false" type="String">
<help><![CDATA[
(populate read) Pathname for the XML data file.
if action="populate", the data from this file
populates the fields of the PDF form.
if action="read", ColdFusion writes the data
to this file.
You can specify a pathname relative to the context
root or a relative pathname.
You must specify either the datafile attribute
or the result attribute for the read action;
you can specify both. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="populate"/>
<selectedValue attributeName="action"
required="false" value="read"/>
</triggers>
</parameter>
<parameter name="destination" required="false" type="String">
<help><![CDATA[
(populate) Pathname for the output file.
You can specify an absolute pathname or
a pathname relative to the context root.
The file extension must be PDF or XDP.
The file extension determines the format
of the file. (The XDP format applies only
to LiveCycle forms.)
If you do not specify the destination,
ColdFusion displays the form in the browser.
Do not specify the destination when you
embed a form in a PDF document. (optional)
]]></help>
</parameter>
<parameter name="overwrite" required="false" type="Boolean">
<help><![CDATA[
(populate, read) Overwrite the destination file
(if action="populate)
or the data file (if action="read"):
yes
no (optional)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="populate"/>
<selectedValue attributeName="action"
required="false" value="read"/>
</triggers>
</parameter>
<parameter name="overwritedata" required="false" type="Boolean">
<help><![CDATA[ Specifies whether to overwrite existing data in PDF form fields with data from the data source:
* yes: Overwrite existing data in the form fields with that from the data source.
* no: Retain existing data in form fields and populate only those fields without data.
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
</parameter>
<parameter name="result" required="false" type="Any">
<help><![CDATA[
(read) ColdFusion structure that contains the form field values.
You must specify the datafile attribute or the result attribute;
you can specify both. (optional)
]]></help>
<values/>
</parameter>
<parameter name="source" required="true" returnVarType="Struct" type="String">
<help><![CDATA[
(populate, read) Pathname of the source PDF (absolute path or path
relative to the context root) or byte array representing a PDF. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="populate"/>
<selectedValue attributeName="action"
required="true" value="read"/>
</triggers>
</parameter>
<parameter name="xmldata" required="false" type="Boolean">
<help><![CDATA[ Pathname for the XML data file.
* If action="populate", the data from this file, XML object, or XML string populates the form fields. You can specify a pathname relative to the context root or a relative pathname.
* If action="read", ColdFusion writes the data to the variable.
]]></help>
<values>
<value option="populate"/>
<value option="read"/>
</values>
</parameter>
<parameter name="name" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
Specify the PDF document variable name, for example, myPDFdoc.
If the source is a PDF document variable, you cannot specify the
name attribute again; you can write the modified PDF document
to the destination. (optional)
]]></help>
<values/>
</parameter>
<parameter name="fdf" required="false" type="Boolean">
<help><![CDATA[
If set to true, the system creates FDF with subforms and params instead of an XML
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="fdfData" required="false" type="String">
<help><![CDATA[
For populate, you specify the file name from where the FDF data will be imported.
For read, you specify the file name where the FDF data will be exported.
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination switchvalue="populate">
<required>source</required>
<optional>destination,overwrite,overwritedata,xmldata,name,fdf,fdfData</optional>
</combination>
<combination switchvalue="read">
<required>source</required>
<optional>overwrite,result,xmldata,fdfData</optional>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="false" name="cfpdfformparam"
single="true" xmlstyle="false">
<help><![CDATA[
Provides additional information to the cfpdfform tag.
The cfpdfformparam tag is always a child tag of the cfpdfform or cfpdfsubform tag.
Use the cfpdfformparam tag to populate fields in a PDF form.
]]></help>
<parameter name="index" required="false" type="Numeric">
<help><![CDATA[
Specify the index associated with the field name.
If multiple fields have the same name, the index
value is used to locate one of them. (optional, default=1)
]]></help>
<values/>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
The field name on the PDF form. (requiredl)
]]></help>
<values/>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
The value associated with the field name.
For interactive fields, specify a ColdFusion variable. (optional)
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name,value</required>
<optional>index</optional>
</combination>
<combination attributename="name">
<required>name,value</required>
<optional/>
</combination>
<combination attributename="value">
<required>name,value</required>
<optional>index</optional>
</combination>
<combination attributename="value">
<required>name,value</required>
<optional/>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="false" name="cfpdfparam"
single="false" xmlstyle="false">
<help><![CDATA[
Provides additional information for the cfpdf tag.
The cfpdfparam tag applies only to the merge action of the cfpdf tag.
The cfpdfparam tag is always a child tag of the cfpdf tag.
]]></help>
<parameter name="password" required="false" type="String">
<help><![CDATA[
Specify the user or owner password, if the source PDF file is passwordprotected. (optional)
]]></help>
<values/>
</parameter>
<parameter name="source" required="true" type="String">
<help><![CDATA[
Specify the source PDF file to merge. (optional)
]]></help>
<values/>
</parameter>
<parameter name="pages" required="false" type="String">
<help><![CDATA[
Page or pages of the PDF source file to merge. You can specify a range of pages, for example, "1-5 ", or a comma-separated list of pages, for example, "1-5,9-10,18".
]]></help>
</parameter>
<possiblecombinations>
<combination attributename="source">
<required>source</required>
<optional>pages,password</optional>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="true" name="cfpdfsubform"
single="false" xmlstyle="true">
<help><![CDATA[
Populates a subform within the cfpdfform tag.
The cfpdfsubform tag can be a child tag of the cfpdfform tag
or nested in another cfpdfsubform tag.
]]></help>
<parameter name="index" required="false" type="Numeric">
<help><![CDATA[
Index associated with the field name.
If multiple fields have the same name, ColdFusion
uses the index value is to locate one of them. (optional, default=1)
]]></help>
<values/>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Name of the subform corresponding to subform name in the PDF form. (required)
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>index</optional>
</combination>
<combination attributename="name">
<required>name</required>
<optional/>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="true" name="cfpresentation"
single="false" xmlstyle="true">
<help><![CDATA[
Defines the look and feel of a dynamic slide presentation.
Use the cfpresentation tag as the parent tag for one or more cfpresentationslide tags,
where you define the content for the presentation.
]]></help>
<parameter name="backgroundColor" required="false" type="String">
<help><![CDATA[
Specifies the background color of the presentation.
The value is hexadecimal: use the form "##xxxxxx" or "##xxxxxxxx",
where x = 0-9 or A-F; use two number signs or none. (optional, default=0x727971)
]]></help>
<values/>
</parameter>
<parameter name="control" required="false" type="String">
<help><![CDATA[
Specifies the presentation control:
normal
brief (optional, default=normal)
]]></help>
<values>
<value option="normal"/>
<value option="brief"/>
</values>
</parameter>
<parameter name="controlLocation" required="false" type="String">
<help><![CDATA[
Specifies the location of the presentation control:
right
left (optional, default= right)
]]></help>
<values>
<value option="right"/>
<value option="left"/>
</values>
</parameter>
<parameter name="directory" required="false" type="String">
<help><![CDATA[
Specifies the directory where the presentation is saved.
This can be absolute path or a path relative to the CFM page.
ColdFusion automatically generates the files necessary to
run the presentation, including:
index.htm
components.swf
loadflash.js
viewer.swf
ColdFusion stores any data files in the presentation,
including images, video clips, and SWF files referenced by the
cfpresentationslide tags in a subdirectory called data.
To run the presentation, open the index.htm file.
If you do not specify a directory, the presentation
runs in the client browser. (optional)
]]></help>
<values/>
</parameter>
<parameter name="glowColor" required="false" type="String">
<help><![CDATA[
Specifies the color used for glow effects on the buttons.
The value is hexadecimal: use the form "##xxxxxx" or "##xxxxxxxx",
where x = 0-9 or AF; use two number signs or none. (optional, default=0x35D334)
]]></help>
<values/>
</parameter>
<parameter name="initialTab" required="false" type="String">
<help><![CDATA[
Specifies which tab will be on top when the presentation is displayed.
This applies only when the control value is normal:
outline
search
notes (optional, default=outline)
]]></help>
<values>
<value option="outline"/>
<value option="search"/>
<value option="notes"/>
</values>
</parameter>
<parameter name="lightColor" required="false" type="String">
<help><![CDATA[
Specifies the light color used for light-and shadow effects.
The value is hexadecimal: use the form "##xxxxxx" or "##xxxxxxxx",
where x = 0-9 or A-F; use two number signs or none. (optional, default=0x4E5D60)
]]></help>
<values/>
</parameter>
<parameter name="overwrite" required="false" type="Boolean">
<help><![CDATA[
Specifies whether files in the directory are overwritten.
Specify this attribute only when the you specify the directory.
yes: overwrites files if they are already present
no: create new files (optional, default=yes)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
</parameter>
<parameter name="primaryColor" required="false" type="String">
<help><![CDATA[
Specifies the primary color of the presentation.
The value is hexadecimal: use the form "##xxxxxx" or "##xxxxxxxx",
where x = 0-9 or AF; use two number signs or none. (optional, default=0x6F8488)
]]></help>
<values/>
</parameter>
<parameter name="shadowColor" required="false" type="String">
<help><![CDATA[
Specifies the shadow color used for light-and shadow effects.
The value is hexadecimal: use the form "##xxxxxx" or "##xxxxxxxx",
where x = 0-9 or A-F; use two number signs or none. (optional, default=0x000000)
]]></help>
<values/>
</parameter>
<parameter name="showNotes" required="false" type="Boolean">
<help><![CDATA[
Specifies whether the notes tab is present:
yes
no (optional, default=no)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
</parameter>
<parameter name="showOutline" required="false" type="Boolean">
<help><![CDATA[
Specifies whether the outline is present:
yes
no (optional, default=yes)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
</parameter>
<parameter name="showSearch" required="false" type="Boolean">
<help><![CDATA[
Specifies whether the search tab is present:
yes
no (optional, default=yes)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
</parameter>
<parameter name="textColor" required="false" type="String">
<help><![CDATA[
Specifies the color for all the text in the presentation user interface. (optional, default=0xFFFFFF)
]]></help>
<values/>
</parameter>
<parameter name="title" required="true" type="String">
<help><![CDATA[
Specifies the title of the presentation. (optional)
]]></help>
<values/>
</parameter>
<parameter name="authpassword" required="false" type="String">
<help><![CDATA[
Sends a password to the target URL for Basic Authentication. Combined with username to form a base64 encoded string that is passed in the Authenticate header.
]]></help>
</parameter>
<parameter name="authuser" required="false" type="String">
<help><![CDATA[
Sends a user name to the target URL for Basic Authentication. Combined with password to form a base64 encoded string that is passed in the Authenticate header.
]]></help>
</parameter>
<parameter name="autoplay" required="false" type="Boolean">
<help><![CDATA[
Specifies whether to play the presentation automatically:
* true: the presentation automatically runs through the entire presentation at startup.
* false: the user must click the Play button to start the presentation and click the Next button to advance to the next slide in the presentation.
]]></help>
<values default="true">
<value option="false"/>
<value option="true"/>
</values>
</parameter>
<parameter name="loop" required="false" type="Boolean">
<help><![CDATA[
Specifies whether the presentation runs in a loop:
* true: the presentation restarts automatically after it ends.
* false: the user must click the Play button to restart the presentation.
]]></help>
<values default="false">
<value option="false"/>
<value option="true"/>
</values>
</parameter>
<parameter name="proxypassword" required="false" type="String">
<help><![CDATA[
Password required by the proxy server.
]]></help>
</parameter>
<parameter name="proxyuser" required="false" type="String">
<help><![CDATA[
User name to provide to the proxy server.
]]></help>
</parameter>
<parameter name="proxyhost" required="false" type="String">
<help><![CDATA[
Host name or IP address of a proxy server to which to send the request.
]]></help>
</parameter>
<parameter name="proxyport" required="false" type="String">
<help><![CDATA[
The port to connect to on the proxy server.
]]></help>
</parameter>
<parameter name="useragent" required="false" type="String">
<help><![CDATA[
Text to put in the HTTP User-Agent request header field. Used to identify the request client software.
]]></help>
</parameter>
<parameter name="destination" required="false" type="String">
<help><![CDATA[
Destination directory
]]></help>
</parameter>
<parameter name="format" required="false" type="String">
<help><![CDATA[
Specifies file format for conversion
]]></help>
<values >
<value option="html"/>
<value option="ppt"/>
</values>
</parameter>
<possiblecombinations/>
</tag>
<tag creator="8" endtagrequired="true"
name="cfpresentationslide" single="false" xmlstyle="true">
<help><![CDATA[
Creates a slide dynamically from an HTML source file,
HTML and CFML code, or an SWF source file.
If you do not specify a source file, you must include the HMTL or CFML code for
the body of the slide within the cfpresentationslide tag. The cfpresentationslide
is the child tag of the cfpresentation tag.
]]></help>
<parameter name="audio" required="false" type="String">
<help><![CDATA[
Specifies the path of the audio file relative to the CFM page.
The audio file must be an MP3 file.
A slide cannot have both audio and video specified (optional)
]]></help>
<values/>
</parameter>
<parameter name="bottomMargin" required="false" type="Numeric">
<help><![CDATA[
Specifies the bottom margin of the slide. (optional, default=0)
]]></help>
<values/>
</parameter>
<parameter name="duration" required="false" type="Numeric">
<help><![CDATA[
Specifies the duration in seconds that the slide is played. (required)
]]></help>
<values/>
</parameter>
<parameter name="notes" required="false" type="String">
<help><![CDATA[
Specifies the notes used for the slide. (optional)
]]></help>
<values/>
</parameter>
<parameter name="presenter" required="false" type="String">
<help><![CDATA[
Specifies the presenter of the slide.
A slide can have only one presenter.
This name must match one of the presenter names in the cfpresenter tag.
If no presenter is specified, it will take the first presenter
specified in the presenter list. (optional)
]]></help>
<values/>
</parameter>
<parameter name="rightMargin" required="false" type="Numeric">
<help><![CDATA[
Specifies the right margin of the slide. (optional, default=0)
]]></help>
<values/>
</parameter>
<parameter name="scale" required="false" type="Numeric">
<help><![CDATA[
Specifies the scale used for the HTML content on the slide
presentation. If the scale attribute is not specified and
the content cannot fit in one slide, it will automatically
be scaled down to fit on the slide. (optional, default=1.0)
]]></help>
<values/>
</parameter>
<parameter name="src" required="false" type="String">
<help><![CDATA[
HTML or SWF source files used as a slide. You can specify
the following as the slide source:
an absolute path
a path relative to the CFM page
a URL: you can specify the URL only if the source is an HTML file
SWF files must be present on the system running ColdFusion and the path
must either be an absolute path or path relative to the CFM page.
If the src value is not specified, you must specify HTML/CFML code
as the body. If you specify a source file and HTML /CFML, ColdFusion
ignores the source file and displays the HTML/CFML in the slide. (optional)
]]></help>
<values/>
</parameter>
<parameter name="title" required="false" type="String">
<help><![CDATA[
Specifies the title of the slide. (required)
]]></help>
<values/>
</parameter>
<parameter name="topMargin" required="false" type="Numeric">
<help><![CDATA[
Specifies the top margin of the slide. (optional, default=0)
]]></help>
<values/>
</parameter>
<parameter name="video" required="false" type="String">
<help><![CDATA[
Specifies the video file used for the presenter of the slide.
If you specify video for the slide and an image for the presenter,
the video is used instead of the image for the slide. You cannot specify
both audio and video for a slide. The video must be an FLV file. (optional)
]]></help>
<values/>
</parameter>
<parameter name="advance" required="false" type="String">
<help><![CDATA[
Overrides the cfpresentation tag autoPlay attribute for the slide:
* auto: after the slide plays, the presentation advances to the next slide automatically. This is the default value if cfpresentation autoPlay="yes".
* never: after the slide plays, the presentation does not advance to the next slide until the user clicks the Next button. This is the default value if cfpresentation autoPlay="no".
* click: after the slide plays, the presentation advances to the next slide if the user clicks anywhere in the main presentation area.
]]></help>
<values>
<value option="auto"/>
<value option="never"/>
<value option="click"/>
</values>
</parameter>
<parameter name="authpassword" required="false" type="String">
<help><![CDATA[
Use to pass a password to the target URL for Basic Authentication. Combined with username to form a base64 encoded string that is passed in the Authenticate header.
]]></help>
</parameter>
<parameter name="authuser" required="false" type="String">
<help><![CDATA[
Use to pass a user name to the target URL for Basic Authentication. Combined with password to form a base64 encoded string that is passed in the Authenticate header.
]]></help>
</parameter>
<parameter name="marginbottom" required="false" type="Numeric">
<help><![CDATA[
Bottom margin of the slide.
]]></help>
</parameter>
<parameter name="marginleft" required="false" type="Numeric">
<help><![CDATA[
Left margin of the slide.
]]></help>
</parameter>
<parameter name="marginright" required="false" type="Numeric">
<help><![CDATA[
Right margin of the slide.
]]></help>
</parameter>
<parameter name="margintop" required="false" type="Numeric">
<help><![CDATA[
Top margin of the slide.
]]></help>
</parameter>
<parameter name="useragent" required="false" type="String">
<help><![CDATA[
Text to put in the HTTP User-Agent request header field. Identifies the request client software.
]]></help>
</parameter>
<parameter name="slides" required="false" type="String">
<help><![CDATA[
Used to specify the slide numbers required to export from ppt file
]]></help>
</parameter>
<possiblecombinations/>
</tag>
<tag creator="8" endtagrequired="false" name="cfpresenter"
single="true" xmlstyle="false">
<help><![CDATA[
Describes a presenter in a slide presentation. A slide presentation can have multiple presenters.
The presenters must be referenced from the slides defined by the cfpresentationslide tag.
]]></help>
<parameter name="biography" required="false" type="String">
<help><![CDATA[
Specifies the biography of the presenter. (required)
]]></help>
<values/>
</parameter>
<parameter name="email" required="false" type="String">
<help><![CDATA[
The name to use for the JavaScript proxy class. (optional)
]]></help>
<values/>
</parameter>
<parameter name="image" required="false" type="String">
<help><![CDATA[
Specifies the path for the presenter's image in JPEG format.
The JPG file must be relative to theCFM page. (optional)
]]></help>
<values/>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Specifies the name of the presenter. (required)
]]></help>
<values/>
</parameter>
<parameter name="logo" required="false" type="String">
<help><![CDATA[
Specifies the path for the presenter's logo or the logo of
the presenters organization. The logo must be in JPEG format.
The file must be relative to the CFM page. (optional)
]]></help>
<values/>
</parameter>
<parameter name="title" required="false" type="String">
<help><![CDATA[
Specifies the title of the presenter. (optional)
]]></help>
<values/>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>biography,email,image,logo,title</optional>
</combination>
</possiblecombinations>
</tag>
<tag allowanyattribute="true" creator="8" endtagrequired="true" name="cfthread"
single="false" xmlstyle="true">
<help><![CDATA[
The cfthread tag enables multithreaded programming in ColdFusion.
Threads are independent streams of execution, and multiple threads
on a page can execute simultaneously and asynchronously, letting you
perform asynchronous processing in CFML. CFML code within the cfthread
tag body executes on a separate thread while the page request thread
continues processing without waiting for the cfthread body to finish.
You use this tag to run or end a thread, temporarily stop thread execution,
or join together multiple threads.
]]></help>
<parameter isswitchattribute="true" name="action"
required="false" type="String">
<help><![CDATA[
The action to take, one of the following values:
join Makes the current thread wait until the thread or threads
specified in the name attribute complete processing, or until the
period specified in the timeout attribute passes, before continuing
processing. If you dont specify a timeout and thread you are joining
to doesnt finish, the current thread also cannot finish processing.
run Creates a thread and starts it processing.
sleep Suspends the current threads processing for the time specified
by the duration attribute. This action is useful if one thread must wait
for another thread to do processing without joining the threads.
terminate Stops processing of the thread specified in the name attribute.
If you terminate a thread, the thread scope includes an ERROR metadata
structure with information about the termination. (optional, default=run)
]]></help>
<values>
<value option="join"/>
<value option="run"/>
<value option="sleep"/>
<value option="terminate"/>
</values>
</parameter>
<parameter name="duration" required="false" type="String">
<help><![CDATA[
(sleep) The number of milliseconds for which to suspend thread processing. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="sleep"/>
</triggers>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
The name of the thread to which the action applies:
terminate The name of the thread to stop.
join The name of the thread or threads to join to the current thread.
To specify multiple threads, use a comma-delimited list.
run The name to use to identify the thread being created. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="join"/>
<selectedValue attributeName="action"
required="true" value="terminate"/>
<selectedValue attributeName="action"
required="true" value="run"/>
</triggers>
</parameter>
<parameter name="priority" required="false" type="String">
<help><![CDATA[
The priority level at which to run the thread.
The following values are valid:
HIGH, LOW, NORMAL
Higher priority threads get more processing time than lower priority
threads. Page-level code, the code that is outside of cfthread tags,
always has NORMAL priority. (optional, default=NORMAL)
]]></help>
<values>
<value option="HIGH"/>
<value option="LOW"/>
<value option="NORMAL"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="run"/>
</triggers>
</parameter>
<parameter name="timeout" required="false" type="Numeric">
<help><![CDATA[
The number of milliseconds that the current thread waits for
the thread or threads being joined to finish. If any thread does not
finish by the specified time, the current thread proceeds.
If the attribute value is 0, the default, the current thread continues
waiting until all joining threads finish. If the current thread is the
page thread, the page continues waiting until the threads are joined,
even if you specify a page timeout. (optional, default=0)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="join"/>
</triggers>
</parameter>
<possiblecombinations>
<combination switchvalue="terminate">
<required>name</required>
<optional/>
</combination>
<combination switchvalue="sleep">
<required>duration</required>
<optional/>
</combination>
<combination switchvalue="run">
<required>name</required>
<optional>priority</optional>
</combination>
<combination switchvalue="join">
<required>name</required>
<optional>timeout</optional>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="false" name="cfzip"
single="false" xmlstyle="false">
<help><![CDATA[
Manipulates ZIP and JavaTM Archive (JAR) files.
In addition to the basic zip and unzip functions, use the cfzip tag to delete
entries from an archive, filter files, read files in binary format, list the
contents of an archive, and specify an entrypath used in an executable JAR file.
]]></help>
<parameter isswitchattribute="true" name="action"
required="false" type="String">
<help><![CDATA[
The action to take. Must be one of the following:
delete
list
read
readBinary
unzip
zip
If you do not specify an action, ColdFusion
applies the default action, zip. (optional)
]]></help>
<values default="zip">
<value option="delete"/>
<value option="list"/>
<value option="read"/>
<value option="readBinary"/>
<value option="unzip"/>
<value option="zip"/>
</values>
</parameter>
<parameter name="charset" required="false" type="String">
<help><![CDATA[
The character set used to translate the ZIP or JAR
entry into a text string. Examples of character sets are:
JIS
RFC1345
UTF-16 (optional, default=encoding of the host machine)
]]></help>
<values>
<value option="JIS"/>
<value option="RFC1345"/>
<value option="UTF-16"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="read"/>
</triggers>
</parameter>
<parameter name="destination" required="false" type="String">
<help><![CDATA[
Destination directory where the ZIP or JAR file is extracted. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="unzip" required="true" value="read"/>
</triggers>
</parameter>
<parameter name="entrypath" required="false" type="String">
<help><![CDATA[
Pathname on which the action is performed. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="delete"/>
<selectedValue attributeName="action"
required="false" value="read"/>
<selectedValue attributeName="action"
required="false" value="readBinary"/>
<selectedValue attributeName="action"
required="false" value="unzip"/>
</triggers>
</parameter>
<parameter name="file" required="false" type="String">
<help><![CDATA[
Absolute pathname of the file on which the action is performed.
For example, the full pathname of the ZIP file: c:\temp\log.zip.
If you do not specify the full pathname (for example, file="log.zip"),
ColdFusion creates the file in a temporary directory. You can use the
GetTempDirectory function to access the ZIP or JAR file. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="delete"/>
<selectedValue attributeName="action"
required="true" value="list"/>
<selectedValue attributeName="action"
required="true" value="read"/>
<selectedValue attributeName="action"
required="true" value="readBinary"/>
<selectedValue attributeName="action"
required="true" value="unzip"/>
<selectedValue attributeName="action"
required="true" value="zip"/>
</triggers>
</parameter>
<parameter name="filter" required="false" type="String">
<help><![CDATA[
File filter applied to the action. The action
applies to all files in the pathname specified that match the filter. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="delete"/>
<selectedValue attributeName="action"
required="false" value="list"/>
<selectedValue attributeName="action"
required="false" value="unzip"/>
<selectedValue attributeName="action"
required="false" value="zip"/>
</triggers>
</parameter>
<parameter name="name" required="false" returnVarType="query" type="String">
<help><![CDATA[
Record set name in which the result of the list action is stored.
The record set columns are:
name: filename of the entry in the JAR file. For example, if the entry is
help/docs/index.htm, the name is index.htm.
directory: directory containing the entry. For the example above, the
directory is help/docs. You can obtain the full entry name by concatenating
directory and name. If an entry is at the root level, the directory is empty ('').
size: uncompressed size of the entry, in bytes.
compressedSize: compressed size of the entry, in bytes.
type: type of entry (directory or file).
dateLastModified: last modified date of the entry, cfdate object.
comment: any comment, if present, for the entry.
crc: crc-32 checksum of the uncompressed entry data. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="list"/>
</triggers>
</parameter>
<parameter name="overwrite" required="false" type="Boolean">
<help><![CDATA[
unzip: Specifies whether to overwrite the extracted files:
yes: if the extracted file already exists at the destination specified,
the file is overwritten.
no: if the extracted file already exists at the destination specified,
the file is not overwritten and that entry is not extracted. The remaining
entries are extracted.
zip: Specifies whether to overwrite the contents of a ZIP or JAR file:
yes: overwrites all of the content in the ZIP or JAR file if it exists.
no: updates existing entries and adds new entries to the ZIP or JAR file
if it exists. (optional, default=no)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="unzip"/>
<selectedValue attributeName="action"
required="false" value="zip"/>
</triggers>
</parameter>
<parameter name="prefix" required="false" type="String">
<help><![CDATA[
String added as a prefix to the ZIP or JAR entry.
The string is the name of a subdirectory in which the
entries are added. (optional)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="false" value="zip"/>
</triggers>
</parameter>
<parameter name="recurse" required="false" type="Boolean">
<help><![CDATA[
Specifies whether the action
applies to subdirectories:
yes: includes subdirectories.
no: does not include subdirectories. (optional, default=yes)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="delete"/>
<selectedValue attributeName="action"
required="false" value="list"/>
<selectedValue attributeName="action"
required="false" value="unzip"/>
<selectedValue attributeName="action"
required="false" value="zip"/>
</triggers>
</parameter>
<parameter name="showDirectory" required="false" type="Boolean">
<help><![CDATA[
yes: lists the directories.
no: does not list directories. (optional, default= no)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="list"/>
</triggers>
</parameter>
<parameter name="source" required="false" type="String">
<help><![CDATA[
Source directory to be zipped. Not required
if cfzipparam is specified. (required)
]]></help>
<values/>
<triggers>
<selectedValue attributeName="action"
required="true" value="zip"/>
</triggers>
</parameter>
<parameter name="storePath" required="false" type="Boolean">
<help><![CDATA[
zip: Specifies whether pathnames are stored in the ZIP or JAR file:
yes: pathnames of entries are stored in the ZIP or JAR file.
no: pathnames of the entries are not stored in the ZIP or JAR file.
All the files are placed at the root level. In case of a name conflict,
the last file in the iteration is added.
unzip: Specifies whether files are stored at the entrypath:
yes: the files are extracted to the entrypath.
no: the entrypath is ignored and all the files are extracted
at the root level. (optional, default= yes)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
<triggers>
<selectedValue attributeName="action"
required="false" value="unzip"/>
<selectedValue attributeName="action"
required="false" value="zip"/>
</triggers>
</parameter>
<parameter name="variable" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
Variable in which the read content is stored. (required)
]]></help>
<triggers>
<selectedValue attributeName="action"
required="true" value="read"/>
</triggers>
</parameter>
<possiblecombinations>
<combination switchvalue="list">
<required>file,name</required>
<optional>filter,recurse,showdirectory</optional>
</combination>
<combination switchvalue="readbinary">
<required>entrypath,file,variable</required>
<optional/>
</combination>
<combination switchvalue="unzip">
<required>destination,file</required>
<optional>entrypath,filter,overwrite,recurse,storepath</optional>
</combination>
<combination switchvalue="delete">
<required>file</required>
<optional>entrypath,filter,recurse</optional>
</combination>
<combination switchvalue="zip">
<required>file</required>
<optional>action,filter,overwrite,prefix,recurse,source,storepath</optional>
</combination>
<combination switchvalue="read">
<required>entrypath,file,variable</required>
<optional>charset</optional>
</combination>
</possiblecombinations>
</tag>
<tag creator="8" endtagrequired="false" name="cfzipparam"
single="true" xmlstyle="false">
<help><![CDATA[
Provides additional information to the cfzip tag.
The cfzipparam tag is always a child tag of the cfzip tag.
]]></help>
<parameter name="charset" required="false" type="String">
<help><![CDATA[
Converts string content into binary data before putting
it into a ZIP or JAR file. Used only when cfzip
action="zip" and the cfzipparam content is a string.
Examples of character sets are:
JIS
RFC1345
UTF-16 (optional, default=encoding of the host machine)
]]></help>
<values>
<value option="JIS"/>
<value option="RFC1345"/>
<value option="UTF-16"/>
</values>
</parameter>
<parameter name="content" required="false" type="String">
<help><![CDATA[
Content written to the ZIP or JAR entry. Used only when cfzip action="zip".
Valid content data types are binary and string. If you specify the content
attribute, you must specify the entrypath attribute. (optional)
]]></help>
<values/>
</parameter>
<parameter name="entrypath" required="false" type="String">
<help><![CDATA[
Pathanme used:
For cfzip action="zip", it is the entrypath used. This is valid only
when the source is a file. The entrypath creates a subdirectory within
the ZIP or JAR file.
For cfzip action="unzip", it is the pathname to unzip.
For cfzip action="delete", it is the pathname to delete from the
ZIP or JAR file. (optional)
]]></help>
<values/>
</parameter>
<parameter name="filter" required="false" type="String">
<help><![CDATA[
File filter applied to the action. For example, for the zip action,
all the files in the source directory matching the filter are zipped. (optional)
]]></help>
<values/>
</parameter>
<parameter name="prefix" required="false" type="String">
<help><![CDATA[
String added as a prefix to the ZIP or JAR entry. Used only
when cfzip action="zip". (optional)
]]></help>
<values/>
</parameter>
<parameter name="recurse" required="false" type="Boolean">
<help><![CDATA[
Recurse the directory to be zipped, unzipped, or deleted,
as specified by the cfzip parent tag. (optional, default=yes)
]]></help>
<values>
<value option="yes"/>
<value option="no"/>
</values>
</parameter>
<parameter name="source" required="false" type="String">
<help><![CDATA[
Source directory or file. Used only when cfzip action="zip".
Specified file(s) are added to the ZIP or JAR file:
If you specify source attribute for the cfzip tag, the
cfzipparam source is relative to it.
If you do not specify a source attribute for the cfzip
tag, the cfzipparam source must be an absolute path. (optional)
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<tag name="cfprogressbar" single="false" xmlstyle="true">
<help><![CDATA[
Creates progressbar
]]></help>
<parameter name="width" required="false" type="String">
<help><![CDATA[
Width in pixel. Default='300'
]]></help>
</parameter>
<parameter name="height" required="false" type="String">
<help><![CDATA[
Height in pixel.
]]></help>
</parameter>
<parameter name="bind" required="false" type="String">
<help><![CDATA[
A bind expression specifying a client JavaScript function or server CFC that the control calls to get progress information each time the period defined by the
interval attribute elapses. You cannot use this attribute with a duration attribute.
]]></help>
</parameter>
<parameter name="oncomplete" required="false" type="String">
<help><![CDATA[
This function will be called by CF once work is done. This can be used to reset status of progress bar text or enabling the button, which might be in disable mode while task was under progress or something more.
]]></help>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Name of the progressBar.
]]></help>
</parameter>
<parameter name="duration" required="false" type="String">
<help><![CDATA[
If callback is not defined then based on this value, ColdFusion will decide percentage work done. One of the callback or totaltime attribute needs to be defined.
]]></help>
</parameter>
<parameter name="interval" required="false" type="String">
<help><![CDATA[
Time interval on which progressbar will keep on updating.
]]></help>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
The following are the supported styles:•
bgcolor: The background color for the progress bar. A hexadecimal value without “#” prefixed.
textcolor: Text color on progress bar.
progresscolor: Color used to indicate the progress
]]></help>
<values>
<value option="bgcolor" />
<value option="progresscolor" />
<value option="textcolor" />
</values>
</parameter>
<parameter name="autoDisplay" required="false" type="String">
<help><![CDATA[
Set to true to display the progress bar.
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="onError" required="false" type="String">
<help><![CDATA[
The JavaScript function to run on an error condition. The error can be a network error or server-side error.
]]></help>
<values />
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name</required>
<optional>bind,duration,height,interval,oncomplete,width</optional>
</combination>
</possiblecombinations>
</tag>
<tag name="cfspreadsheet" single="false" xmlstyle="false">
<help><![CDATA[
Manages Excel spreadsheet files:
]]></help>
<return paramater="name" type="variablename" />
<return paramater="query" type="query" />
<parameter name="password" required="false" type="String">
<help><![CDATA[
Set a password for modifying the sheet.
]]></help>
</parameter>
<parameter name="sheetname" required="false" type="String">
<help><![CDATA[
Name of the sheet.
]]></help>
</parameter>
<parameter isswitchattribute="true" name="action"
required="false" type="String">
<help><![CDATA[
One of the following:
• read - Reads the contents of an XLS format file.
• update - Adds a new sheet to an existing XLS file. You cannot use the uppdate
action to change an existing sheet in a file. For more information, see Usage.
• write - Writes a new XLS format file or overwrites an existing file.
]]></help>
<values>
<value option="write"/>
<value option="update"/>
<value option="read"/>
</values>
</parameter>
<parameter name="rows" required="false" type="String">
<help><![CDATA[
The range of rows to read. Specify a single number, a hypen-separated row range, a comma-separated list, or any combination of these; for example: 1,3-6,9.
]]></help>
</parameter>
<parameter name="overwrite" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether to overwrite an existing file.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="src" required="false" type="String">
<help><![CDATA[
The pathname of the file to read.
]]></help>
</parameter>
<parameter name="filename" required="false" type="String">
<help><![CDATA[
The pathname of the file that is written.
]]></help>
</parameter>
<parameter name="columns" required="false" type="String">
<help><![CDATA[
Column number or range of columns. Specify a single number, a hypen-separated column range, a comma-separated list, or any combination of these; for example: 1,3-6,9.
]]></help>
</parameter>
<parameter name="columnnames" required="false" type="String">
<help><![CDATA[
Comma-separated column names.
]]></help>
</parameter>
<parameter name="query" required="false" returnVarType="query" type="String">
<help><![CDATA[
• read action: The query in which to store the converted spreadsheet file. You must specify format, name
, or query.
• write and update actions: A query variable containing the data to write. You must specify name or query.
]]></help>
</parameter>
<parameter name="sheet" required="false" type="Numeric">
<help><![CDATA[
Number of the sheet.
]]></help>
</parameter>
<parameter name="headerrow" required="false" type="Numeric">
<help><![CDATA[
Row number that contains column names.
]]></help>
</parameter>
<parameter name="name" required="false" returnVarType="variablename" type="String">
<help><![CDATA[
read action: The variable in which to store the spreadsheet file data. You must specify name or query.if format='csv' then name will contain csv variable.
if format='html' then name will contain html content.
write and update actions: A variable containing CSV-format data or an ColdFusion spreadsheet object containing the data to write. You must specify name or query.
]]></help>
</parameter>
<parameter name="format" required="false" type="String">
<help><![CDATA[
Format of the data represented by the name variable.
]]></help>
<values>
<value option="html" />
<value option="csv" />
</values>
</parameter>
<possiblecombinations>
<combination switchvalue="write">
<optional>action,filename,format,name,overwrite,password,query,sheet,sheetname</optional>
</combination>
<combination switchvalue="update">
<optional>action,filename,format,name,password,query,sheet,sheetname</optional>
</combination>
<combination switchvalue="read">
<optional>action,columnnames,columns,format,headerrow,name,query,rows,sheet,sheetname,src</optional>
</combination>
</possiblecombinations>
</tag>
<tag name="cfmediaplayer" single="false" xmlstyle="true">
<help><![CDATA[
Creates an in-built media player that lets you play FLV files
]]></help>
<parameter name="width" required="false" type="String">
<help><![CDATA[
Width of the media player, in pixels.
]]></help>
</parameter>
<parameter name="height" required="false" type="String">
<help><![CDATA[
Height of the media player, in pixels.
]]></help>
</parameter>
<parameter name="fullscreencontrol" required="false" type="Boolean">
<help><![CDATA[
Whether full screen is enabled
]]></help>
<values>
<value option="false" />
<value option="true" />
</values>
</parameter>
<parameter name="hideBorder" required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies if you want to hide border for the media player panel
]]></help>
<values>
<value option="false" />
<value option="true" />
</values>
</parameter>
<parameter name="controlbar" required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies if you want to display the control panel for the media player
]]></help>
<values>
<value option="false" />
<value option="true" />
</values>
</parameter>
<parameter name="align" required="false" type="String">
<help><![CDATA[
Specifies the vertical alignment of the media player.
]]></help>
<values>
<value option="left" />
<value option="right" />
<value option="center" />
</values>
</parameter>
<parameter name="onload" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to run on loading th player component.
]]></help>
</parameter>
<parameter name="bgcolor" required="false" type="String">
<help><![CDATA[
The background color of the media player specified as a Hexadecimal value without a "#"
]]></help>
</parameter>
<parameter name="source" required="true" type="String">
<help><![CDATA[
The URL to the FLV file.
]]></help>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
Name of the media player.
The name attribute is required when you invoke JavaScript functions.
]]></help>
</parameter>
<parameter name="quality" required="false" type="String">
<help><![CDATA[
The quality of the media playback
]]></help>
<values>
<value option="high" />
<value option="medium" />
<value option="low" />
</values>
</parameter>
<parameter name="hideTitle" required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies if you want to hide title for the media player panel
]]></help>
<values>
<value option="false" />
<value option="true" />
</values>
</parameter>
<parameter name="oncomplete" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to run when the FLV file has finished playing.
]]></help>
</parameter>
<parameter name="onstart" required="false" type="String">
<help><![CDATA[
Custom JavaScript function to run when the FLV file starts playing.
]]></help>
</parameter>
<parameter name="wmode" required="false" type="String">
<help><![CDATA[
Specifies the absolute positioning and layering capabilities in your browser
]]></help>
<values>
<value option="opaque" />
<value option="transparent" />
<value option="window" />
</values>
</parameter>
<parameter name="autoPlay" required="false" type="Boolean">
<help><![CDATA[
A Boolean value that specifies if the media player should automatically play the FLV file on loading the CFM page.
]]></help>
<values>
<value option="false" />
<value option="true" />
</values>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
Specify style for mediaplayer
]]></help>
<values/>
</parameter>
<possiblecombinations/>
</tag>
<tag name="cffileupload" single="false" xmlstyle="true">
<help><![CDATA[
Ajax File upload
]]></help>
<parameter name="url" required="true" type="String">
<help><![CDATA[
The URL to the server where the files are uploaded.
]]></help>
</parameter>
<parameter name="width" required="false" type="String">
<help><![CDATA[
Width of the file upload control, in pixels.
]]></help>
</parameter>
<parameter name="title" required="false" type="String">
<help><![CDATA[
Title for the upload dialog.
]]></help>
</parameter>
<parameter name="extensionfilter" required="false" type="String">
<help><![CDATA[
Use this attribute to specify the type of file that you will allow to be uploaded.
For example, to let only image files to be uploaded, you can specify file extensions like .jpg, .jpeg, or .png
]]></help>
</parameter>
<parameter name="uploadbuttonlabel" required="false" type="String">
<help><![CDATA[
Label of the Upload button.
]]></help>
</parameter>
<parameter name="progressbar" required="false" type="Boolean">
<help><![CDATA[
Whether to display Progress Bar or not. Default true
]]></help>
<values >
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="height" required="false" type="String">
<help><![CDATA[
Height of the file upload control, in pixels.
]]></help>
</parameter>
<parameter name="maxUploadSize" required="false" type="Numeric">
<help><![CDATA[
The maximum file size, in mega bytes, allowed for the upload. Default 10MB.
]]></help>
</parameter>
<parameter name="maxFileSelect" required="false" type="String">
<help><![CDATA[
The maximum number of files allowed for the upload.
]]></help>
</parameter>
<parameter name="style" required="false" type="String">
<help><![CDATA[
A CSS style specification that defines layout styles
]]></help>
</parameter>
<parameter name="bgcolor" required="false" type="String">
<help><![CDATA[
The background color for the file upload control. A hexadecimal value without “#” prefixed.
]]></help>
</parameter>
<parameter name="addButtonLabel" required="false" type="String">
<help><![CDATA[
Label of the Add button
]]></help>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
Name of the file upload component.
]]></help>
</parameter>
<parameter name="oncomplete" required="false" type="String">
<help><![CDATA[
The JavaScript function to run after the file upload completes
]]></help>
</parameter>
<parameter name="onerror" required="false" type="String">
<help><![CDATA[
The JavaScript function to run on an error condition. The error can be a network error or server-side error
]]></help>
</parameter>
<parameter name="clearButtonLabel" required="false" type="String">
<help><![CDATA[
Label of the Clear button
]]></help>
</parameter>
<parameter name="deleteButtonLabel" required="false" type="String">
<help><![CDATA[
Label of the Delete button
]]></help>
</parameter>
<parameter name="align" required="false" type="String">
<help><![CDATA[
Specifies the default alignment
]]></help>
<values>
<value option="left" />
<value option="right" />
<value option="center" />
<value option="justify" />
</values>
</parameter>
<parameter name="wmode" required="false" type="String">
<help><![CDATA[
Specifies the absolute positioning and layering capabilities in your browser:
]]></help>
<values>
<value option="opaque" />
<value option="transparent" />
<value option="window" />
</values>
</parameter>
<parameter name="stopOnError" required="false" type="boolean">
<help><![CDATA[
Specifies whether or not to ignore the exceptions for this operation. When the value is
true, it stops uploading, displays an appropriate error
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="hideUploadButton" required="false" type="boolean">
<help><![CDATA[
A Boolean value that specifies if the Upload button should appear in the media player
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="onUploadComplete" required="false" type="String">
<help><![CDATA[
The JavaScript function to run after the all uploads have completed
]]></help>
</parameter>
<possiblecombinations>
<combination attributename="action">
<required>action</required>
<optional>addbuttonlabel,bgcolor,clearbottonlabel,extensionfilter,height,maxfileselect,maxuploadsize,name,onuploadcomplete,progressbar,style,title,uploadbuttonlabel,width,onUploadComplete</optional>
</combination>
</possiblecombinations>
</tag>
<tag name="cfsharepoint" single="false" xmlstyle="true">
<help><![CDATA[
Invokes a feature that SharePoint exposes as a web service action, such as the Document Workspace
getdwsdata action.
]]></help>
<return parameter="name" type="Struct"/>
<parameter name="password" required="false" type="String">
<help><![CDATA[
The password required to connect to the SharePoint server. Required if you do not specify a
login attribute.
]]></help>
</parameter>
<parameter name="action" required="true" type="String">
<help><![CDATA[
The name of a web service action. See Usage for the list of service actions you can specify.
]]></help>
<values>
<value option="cancreatedwsurl" />
<value option="createdws" />
<value option="createdwsfolder" />
<value option="deletedws" />
<value option="deletedwsfolder" />
<value option="finddwsdoc" />
<value option="getdwsdata" />
<value option="removedwsuser" />
<value option="renamedws" />
<value option="updatedwsdata" />
<value option="delete" />
<value option="download" />
<value option="getimaginglistitems" />
<value option="getitemsbyids" />
<value option="listpicturelibrary" />
<value option="rename" />
<value option="upload" />
<value option="addattachment" />
<value option="addlist" />
<value option="deleteattachment" />
<value option="deletelist" />
<value option="getattachmentcollection" />
<value option="getlist" />
<value option="getlistcollection" />
<value option="getlistitems" />
<value option="updatelist" />
<value option="updatelistitems" />
<value option="query" />
<value option="queryex" />
<value option="registration" />
<value option="status" />
<value option="addgrouptorole" />
<value option="addrole" />
<value option="addusercollectiontogroup" />
<value option="addusercollectiontorole" />
<value option="addusertogroup" />
<value option="getgroupcollection" />
<value option="getrolecollection" />
<value option="getusercollectionfromrole" />
<value option="getusercollectionfromrole" />
<value option="getuserinfo" />
<value option="removerole" />
<value option="removeusercollectionfromgroup" />
<value option="removeuserfromgroup" />
<value option="addview" />
<value option="deleteview" />
<value option="getview" />
<value option="getviewcollection" />
<value option="updateview" />
</values>
</parameter>
<parameter name="login" required="false" type="Struct">
<help><![CDATA[
A structure containing user, password, and domain login credentials to pass to the service. If you do not specify
domain ,password, and userNameattributes you must specify a login structure with domain, password, and userName entries.
]]></help>
</parameter>
<parameter name="params" required="false" type="Struct">
<help><![CDATA[
A structure containing names and values of the parameters to pass to the service.
]]></help>
</parameter>
<parameter name="domain" required="false" type="String">
<help><![CDATA[
The domain name required to connect to the SharePoint server. Required if you do not specify a login attribute.
]]></help>
</parameter>
<parameter name="username" required="false" type="String">
<help><![CDATA[
The user name required to connect to the SharePoint server. Required if you do not specify a
login attribute.
]]></help>
</parameter>
<parameter name="name" required="false" returnVarType="Struct" type="String">
<help><![CDATA[
Name of the result variable in which to put the data returned by the SharePoint service.
]]></help>
</parameter>
<parameter name="wsdl" required="false" type="String">
<help><![CDATA[
Path to the service wsdl file. Required to invoke an action that is not in the list of supported actions. See Usage for details.
]]></help>
</parameter>
<possiblecombinations>
<combination attributename="action">
<required>action,login</required>
<optional>domain,name,params,password,username,wsdl</optional>
</combination>
<combination attributename="action">
<required>action,domain,password,username</required>
<optional>login,name,params,wsdl</optional>
</combination>
</possiblecombinations>
</tag>
<tag name="cfmapitem" single="false" xmlstyle="true">
<help><![CDATA[
This tag creates markers on the map.
]]></help>
<parameter name="longitude" required="false" type="String">
<help><![CDATA[
The longitude value for the marker, in degrees.
]]></help>
</parameter>
<parameter name="address" required="false" type="String">
<help><![CDATA[
The address of the location to set the map marker.
]]></help>
</parameter>
<parameter name="tip" required="false" type="String">
<help><![CDATA[
A short description of the marker location that appears as a tool tip.
]]></help>
</parameter>
<parameter name="latitude" required="false" type="String">
<help><![CDATA[
The latitude value for the marker, in degrees.
]]></help>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
The name of the map.
]]></help>
</parameter>
<parameter name="showMarkerWindow" required="false" type="Boolean">
<help><![CDATA[
When true, the marker infowindow is shown. By default, this is false. This is inherited by all cfmapitem tags.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="markerWindowContent" required="false" type="String">
<help><![CDATA[
Static inner html markup to be displayed in the infowindow opened when the marker is clicked. This is mutually exclusive with the markerbind attribute
]]></help>
<values />
</parameter>
<parameter name="markerIcon" required="false" type="String">
<help><![CDATA[
Location of an image file to use as the marker icon. The attributes markericon and markercolor are mutually exclusive.
]]></help>
<values />
</parameter>
<parameter name="markerColor" required="false" type="String">
<help><![CDATA[
Indicates the color of the marker.
]]></help>
<values />
</parameter>
<possiblecombinations>
<combination attributename="name">
<required/>
<optional>address,latitude,longitude,name,tip,title</optional>
</combination>
</possiblecombinations>
</tag>
<tag name="cfmap" endtagrequired="true" single="false" xmlstyle="true">
<help><![CDATA[
Embeds a Google map within a ColdFusion web page
]]></help>
<parameter name="width" required="false" type="String">
<help><![CDATA[
Map width, in pixels.
]]></help>
</parameter>
<parameter name="centerlongitude" required="false" type="Numeric">
<help><![CDATA[
The longitude value for the location, in degrees
]]></help>
</parameter>
<parameter name="centeraddress" required="false" type="String">
<help><![CDATA[
The address of the location, which is set as the center of the map.
]]></help>
</parameter>
<parameter name="continuouszoom" required="false" type="Boolean">
<help><![CDATA[
Whether to provide zoom control that enables smooth zooming for the map
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
Type of the Google map
]]></help>
<values>
<value option="map"/>
<value option="satellite"/>
<value option="hybrid"/>
<value option="earth"/>
<value option="terrain"/>
</values>
</parameter>
<parameter name="title" required="false" type="String">
<help><![CDATA[
Title of the panel
]]></help>
</parameter>
<parameter name="zoomcontrol" required="false" type="String">
<help><![CDATA[
Whether to enable zoom control
]]></help>
<values>
<value option="none" />
<value option="small" />
<value option="large" />
<value option="small3D" />
<value option="large3D" />
</values>
</parameter>
<parameter name="tip" required="false" type="String">
<help><![CDATA[
A short description of the center location that appears as a tool tip.
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="overview" required="false" type="Boolean">
<help><![CDATA[
Whether to add an Overview panel to the map
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="hideborder" required="false" type="Boolean">
<help><![CDATA[
Whether to hide border for surrounding panel
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="doubleclickzoom" required="false" type="Boolean">
<help><![CDATA[
Whether to enable double-click zoom
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="key" required="false" type="String">
<help><![CDATA[
The API key of the map.
]]></help>
</parameter>
<parameter name="collapsible" required="false" type="Boolean">
<help><![CDATA[
Whether to provide a collapsible property for the surrounding panel
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="zoomlevel" required="false" type="Numeric">
<help><![CDATA[
Specifies the starting zoom value
]]></help>
</parameter>
<parameter name="height" required="false" type="String">
<help><![CDATA[
Height of the map, in pixels
]]></help>
</parameter>
<parameter name="centerlatitude" required="false" type="Numeric">
<help><![CDATA[
The latitude value for the location, in degrees.
]]></help>
</parameter>
<parameter name="onload" required="false" type="String">
<help><![CDATA[
Custom JavaScript function that runs after the map loads..
]]></help>
</parameter>
<parameter name="typecontrol" required="false" type="String">
<help><![CDATA[
What type of typecontrol to provide. Basic inclueds "map, satellite, hybrid" and Advanced includes "map, satellite, hybrid, earth, terrain"
]]></help>
<values>
<value option="none" />
<value option="basic" />
<value option="advanced" />
</values>
</parameter>
<parameter name="displayscale" required="false" type="Boolean">
<help><![CDATA[
Whether to enable scale control
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
Name of the map.
]]></help>
</parameter>
<parameter name="scrollwheelzoom" required="false" type="Boolean">
<help><![CDATA[
Whether to enable mouse wheel zooming control
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="markerBind" required="false" type="String">
<help><![CDATA[
Uses a bind expression to fetch markup to be displayed in the infowindow opened when the marker is clicked. This is mutually exclusive with the markerwindowtext attribute. This is inherited by all cfmapitem tags
]]></help>
<values />
</parameter>
<parameter name="showMarkerWindow" required="false" type="Boolean">
<help><![CDATA[
When true, the marker infowindow is shown. By default, this is false. This is inherited by all cfmapitem tags.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="markerWindowContent" required="false" type="String">
<help><![CDATA[
Static inner html markup to be displayed in the infowindow opened when the marker is clicked. This is mutually exclusive with the markerbind attribute
]]></help>
<values />
</parameter>
<parameter name="markerIcon" required="false" type="String">
<help><![CDATA[
Location of the icon to use for the marker.
]]></help>
<values />
</parameter>
<parameter name="markerColor" required="false" type="String">
<help><![CDATA[
marker color in hexadecimal value.
]]></help>
<values />
</parameter>
<parameter name="onError" required="false" type="String">
<help><![CDATA[
The JavaScript function to run when there is a Google map API error.
The JavaScript function is passed with two parameters, Google map status code and error message.
]]></help>
<values />
</parameter>
<parameter name="showCenterMarker" required="false" type="Boolean">
<help><![CDATA[
Whether to display the marker icon that identifies the map center
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="showScale" required="false" type="Boolean">
<help><![CDATA[
Whether to show scale control
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<possiblecombinations/>
</tag>
<tag name="cfmessagebox" single="false" xmlstyle="true">
<help><![CDATA[
Creates MessageBox
]]></help>
<parameter name="labelcancel" required="false" type="String">
<help><![CDATA[
The text to put on the cancel button of a prompt message box.
]]></help>
</parameter>
<parameter name="callbackHandler" required="false" type="String">
<help><![CDATA[
callback function which will be called when any ok|no|cancel button is clicked
]]></help>
</parameter>
<parameter name="labelok" required="false" type="String">
<help><![CDATA[
The text to put on a alert button and prompt messge box OK button.
]]></help>
</parameter>
<parameter name="title" required="false" type="String">
<help><![CDATA[
The title for the message box.
]]></help>
</parameter>
<parameter name="type" required="true" type="String">
<help><![CDATA[
Type of action to be performed
]]></help>
<values >
<value option="alert"/>
<value option="confirm"/>
<value option="prompt"/>
</values>
</parameter>
<parameter name="message" required="true" type="String">
<help><![CDATA[
Message text which will be displayed
]]></help>
</parameter>
<parameter name="labelno" required="false" type="String">
<help><![CDATA[
The text to put on the button used for a negative response in a confirm message box.
]]></help>
</parameter>
<parameter name="labelyes" required="false" type="String">
<help><![CDATA[
The text to put on the button used for a positive responsein a confirm message box.
]]></help>
</parameter>
<parameter name="multiline" required="false" type="Boolean">
<help><![CDATA[
Applies for prompt action only. Signify whether prompt is textarea(multiliner) or oneliner(textField)Default=false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Name of the messageBox
]]></help>
</parameter>
<parameter name="bodyStyle" required="false" type="String">
<help><![CDATA[
A CSS style specification for the body of the message box. As a general rule, use this attribute to set color and font styles
]]></help>
</parameter>
<parameter name="buttonType" required="false" type="String">
<help><![CDATA[
Applies to the control type - confirm
The buttons to display on the message box
]]></help>
<values >
<value option="yesno" />
<value option="yesnocancel" />
</values>
</parameter>
<parameter name="icon" required="false" type="String">
<help><![CDATA[
Specifies the following CSS classes
error: Provides the error icon. You can use this icon when displaying error messages.
info: Provides the info icon. You can use this icon when displaying any information.
question: Provides the question icon. You can use this icon in a confirmation message box that prompts a user response.
warning: Provides the warning icon. You can use this icon when displaying a warning message
]]></help>
</parameter>
<parameter name="modal" required="false" type="boolean">
<help><![CDATA[
A Boolean value that specifies if the message box should be a modal window
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
Width of the message box in pixels.
]]></help>
</parameter>
<parameter name="x" required="false" type="Numeric">
<help><![CDATA[
The X (horizontal) coordinate of the upper-left corner of the message box .
ColdFusion ignores this attribute if you do not set the y attribute.
]]></help>
</parameter>
<parameter name="y" required="false" type="Numeric">
<help><![CDATA[
The Y (vertical) coordinate of the upper-left corner of the message box.
ColdFusion ignores this attribute if you do not set the x attribute.
]]></help>
</parameter>
<possiblecombinations>
<combination attributename="name">
<required>name,type</required>
<optional>callback,labelcancel,labelno,labelok,labelyes,message,multiline,title</optional>
</combination>
<combination attributename="type">
<required>name,type</required>
<optional>callback,labelcancel,labelno,labelok,labelyes,message,multiline,title</optional>
</combination>
</possiblecombinations>
</tag>
</tags>
<functions>
<function name="abs" returns="Numeric" >
<help><![CDATA[
Absolute-value function. The absolute value of a number is
the number without its sign.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="acos" returns="Numeric" >
<help><![CDATA[
Returns the angle whose cosine is the value passed as the argument.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
The value to be converted into an angle. Must be between -1 and 1.
]]></help>
</parameter>
</function>
<function name="ajaxLink" returns="void" >
<help><![CDATA[
Causes an HTML href attribute to display link results in the current Ajax container.
]]></help>
<parameter name="url" required="true" type="String">
<help><![CDATA[
The URL of the link.
]]></help>
</parameter>
</function>
<function name="ajaxOnLoad" returns="void" >
<help><![CDATA[
Causes the specified JavaScript function to run when the page loads.
]]></help>
<parameter name="functionname" required="true" type="String">
<help><![CDATA[
The name of the function to run when the page loads.
]]></help>
</parameter>
</function>
<function name="applicationStop" returns="void" >
<help><![CDATA[
stops current application
]]></help>
</function>
<function name="arrayContains" returns="boolean" >
<help><![CDATA[
Returns true if specified object is present is given array
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="object" required="true" type="Any">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="arrayDelete" returns="boolean" >
<help><![CDATA[
Deletes specified object from given array
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="object" required="true" type="Any">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="arrayMax" returns="Numeric" >
<help><![CDATA[
Returns the largest numeric value in an array. If the array
parameter value is an empty array, returns zero.
All elements must contain values that can be automatically
converted to numeric values.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="arrayMin" returns="Numeric" >
<help><![CDATA[
Returns the smallest numeric value in an array. If the array
parameter value is an empty array, returns zero.
All elements must contain values that can be automatically
converted to numeric values.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="arraylen" returns="Numeric">
<help><![CDATA[
Determines the number of elements in an array.
CFML MX: this function can be used on child XML objects.
]]></help>
<parameter name="array" type="Array" required="true">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="arrayAppend" returns="boolean" >
<help><![CDATA[
Appends an array element to an array.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
The array to which the element should be appended.
]]></help>
</parameter>
<parameter name="value" required="true" type="Any">
<help><![CDATA[
The element to append. Can be any type.
]]></help>
</parameter>
</function>
<function name="arrayAvg" returns="Numeric" >
<help><![CDATA[
Calculates the average of the values in an array.
All elements in the array must contain values that can be
automatically converted to numeric.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="arrayClear" returns="boolean" >
<help><![CDATA[
Removes all elements from an array.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Array ArrayNew(dimension)
-->
<function name="arrayNew" returns="Array" >
<help><![CDATA[
Creates an array of 1-3 dimensions. Index array elements
with square brackets: [ ].
CFML arrays expand dynamically as data is added.
]]></help>
<parameter name="dimension" required="true" type="Numeric">
<help><![CDATA[
]]></help>
<values default="1">
<value option="1"/>
</values>
</parameter>
</function>
<!--
boolean ArrayPrepend(array, value)
-->
<function name="arrayPrepend" returns="boolean" >
<help><![CDATA[
Inserts an array element at the beginning of an array
and shifts the positions of the existing elements to
make room.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean ArrayResize(array, minimum_size)
-->
<function name="arrayResize" returns="boolean" >
<help><![CDATA[
Resets an array to a specified minimum number of elements.
This can improve performance, if used to size an array to its
expected maximum. For more than 500 elements, use ArrayResize
immediately after using the ArrayNew tag.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="size" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean ArraySet(array, start_pos, end_pos, value)
-->
<function name="arraySet" returns="boolean" >
<help><![CDATA[
In a one-dimensional array, sets the elements in a specified
index range to a value. Useful for initializing an array after
a call to ArrayNew.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="start_pos" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="end_pos" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean ArraySort(array, sort_type [, sort_order ])
-->
<function name="arraySort" returns="boolean" >
<help><![CDATA[
Sorts array elements numerically or alphanumerically.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
Name of an array
]]></help>
</parameter>
<parameter name="sort_type" required="true" type="String">
<help><![CDATA[
numeric: sorts numbers
text: sorts text alphabetically, taking case into account
(also known as case sensitive). All letters of one case
precede the first letter of the other case:
- aabzABZ, if sort_order = "asc" (ascending sort)
- ZBAzbaa, if sort_order = "desc" (descending sort)
textnocase: sorts text alphabetically, without regard to
case (also known as case-insensitive). A letter in varying
cases precedes the next letter:
- aAaBbBzzZ, in an ascending sort; preserves original
intra-letter order
- ZzzBbBaAa, in a descending sort; reverses original
intra-letter order
]]></help>
<values>
<value option="numeric"/>
<value option="text"/>
<value option="textnocase"/>
</values>
</parameter>
<parameter name="sort_order" required="false" type="String">
<help><![CDATA[
asc: ascending sort order. Default.
- aabzABZ or aAaBbBzzZ, depending on value of sort_type,
for letters
- from smaller to larger, for numbers
desc: descending sort order.
- ZBAzbaa or ZzzBbBaAa, depending on value of sort_type,
for letters
- from larger to smaller, for numbers
]]></help>
<values default="asc">
<value option="asc"/>
<value option="desc"/>
</values>
</parameter>
</function>
<!--
Numeric ArraySum(array)
-->
<function name="arraySum" returns="Numeric" >
<help><![CDATA[
The sum of values in an array. If the array parameter value is
an empty array, returns zero.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean ArraySwap(array, position1, position2)
-->
<function name="arraySwap" returns="boolean" >
<help><![CDATA[
Swaps array values of an array at specified positions. This
function is more efficient than multiple cfset tags
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="position1" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="position2" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String ArrayToList(array [, delimiter ])
-->
<function name="arrayToList" returns="String" >
<help><![CDATA[
Converts a one-dimensional array to a list.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiter" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option="_"/>
<value option=";"/>
<value option=":"/>
</values>
</parameter>
</function>
<!--
Numeric Asc(string)
-->
<function name="asc" returns="Numeric" >
<help><![CDATA[
Determines the value of a character.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric ASin(number)
-->
<function name="asin" returns="Numeric" >
<help><![CDATA[
Determines the arcsine of a number. The arcsine is the angle
whose sine is number.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric Atn(number)
-->
<function name="atn" returns="Numeric" >
<help><![CDATA[
Arctangent function. The arctangent is the angle whose tangent
is number.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Binary BinaryDecode(string, binaryencoding)
-->
<function name="binaryDecode" returns="Binary" >
<help><![CDATA[
Converts a string to a binary object. Used to convert
binary data that has been encoded into string format
back into binary data.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string containing encoded binary data.
]]></help>
</parameter>
<parameter name="binaryencoding" required="true" type="String">
<help><![CDATA[
A string specifying the algorithm used to encode the original
binary data into a string; must be one of the following:
- hex: characters 0-9 and A-F represent the hexadecimal value
of each byte; for example, 3A.
- UU: data is encoded using the UNIX UUencode algorithm.
- base64: data is encoded using the Base64 algorithm.
]]></help>
<values>
<value option="hex"/>
<value option="uu"/>
<value option="base64"/>
</values>
</parameter>
</function>
<!--
Binary BinaryEncode(binarydata, encoding)
-->
<function name="binaryEncode" returns="String" >
<help><![CDATA[
Converts binary data to a string.
]]></help>
<parameter name="binarydata" required="true" type="Binary">
<help><![CDATA[
A string containing encoded binary data.
]]></help>
</parameter>
<parameter name="encoding" required="true" type="String">
<help><![CDATA[
A string specifying the encoding method to use to represent
the data; one of the following:
- hex: use characters 0-9 and A-F represent the hexadecimal value
of each byte; for example, 3A.
- UU: use the UNIX UUencode algorithm to convert the data.
- base64: use the Base64 algorithm to convert the data.
]]></help>
<values>
<value option="hex"/>
<value option="uu"/>
<value option="base64"/>
</values>
</parameter>
</function>
<!--
Numeric BitAnd(number1, number2)
-->
<function name="bitAnd" returns="Numeric" >
<help><![CDATA[
Performs a bitwise logical AND operation.
]]></help>
<parameter name="number1" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="number2" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric BitMaskClear(number, start, length)
-->
<function name="bitMaskClear" returns="Numeric" >
<help><![CDATA[
Performs a bitwise mask clear operation.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="start" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="length" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric BitMaskRead(number, start, length)
-->
<function name="bitMaskRead" returns="Numeric" >
<help><![CDATA[
Performs a bitwise mask read operation.
Returns an integer, created from length bits of number,
beginning at start.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="start" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="length" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric BitMaskSet(number, mask, start, length)
-->
<function name="bitMaskSet" returns="Numeric" >
<help><![CDATA[
Performs a bitwise mask set operation.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="mask" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="start" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="length" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric BitNot(number)
-->
<function name="bitNot" returns="Numeric" >
<help><![CDATA[
Performs a bitwise logical NOT operation.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric Bitor(number1, number2)
-->
<function name="bitOr" returns="Numeric" >
<help><![CDATA[
Performs a bitwise logical OR operation.
]]></help>
<parameter name="number1" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="number2" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric BitSHLN(number, count)
-->
<function name="bitShln" returns="Numeric" >
<help><![CDATA[
Performs a bitwise shift-left, no-rotation operation.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="count" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric BitSHRN(number, count)
-->
<function name="bitShrn" returns="Numeric" >
<help><![CDATA[
Performs a bitwise shift-right, no-rotation operation.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="count" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric BitXor(number1, number2)
-->
<function name="bitXor" returns="Numeric" >
<help><![CDATA[
Performs a bitwise logical XOR operation.
]]></help>
<parameter name="number1" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="number2" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric Ceiling(number)
-->
<function name="ceiling" returns="Numeric" >
<help><![CDATA[
Determines the closest integer that is greater than a
specified number.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Binary CharsetDecode(string, encoding)
-->
<function name="charsetDecode" returns="Binary" >
<help><![CDATA[
Converts as string to a binary representation.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string containing data to encode in binary format.
]]></help>
</parameter>
<parameter name="encoding" required="true" type="String">
<help><![CDATA[
A string specifying encoding of the input data.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
</parameter>
</function>
<!--
String CharsetEncode(binaryobject, encoding)
-->
<function name="charsetEncode" returns="Binary" >
<help><![CDATA[
Uses the specified encoding to convert binary data to a string.
]]></help>
<parameter name="binaryobject" required="true" type="Binary">
<help><![CDATA[
A variable containing binary data to decode into text.
]]></help>
</parameter>
<parameter name="encoding" required="true" type="String">
<help><![CDATA[
The character encoding that was used to encode the string into binary format.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
</parameter>
</function>
<!--
Character Chr(number)
-->
<function name="chr" returns="char" >
<help><![CDATA[
Converts a numeric value to a UCS-2 character.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String Cjustify(string, length)
-->
<function name="cjustify" returns="String" >
<help><![CDATA[
Centers a string in a field length.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="length" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric Compare(string1, string2)
-->
<function name="compare" returns="Numeric" >
<help><![CDATA[
Performs a case-sensitive comparison of two strings.
-1, if string1 is less than string2
0, if string1 is equal to string2
1, if string1 is greater than string2
]]></help>
<parameter name="string1" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="string2" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric CompareNoCase(string1, string2)
-->
<function name="compareNoCase" returns="Numeric" >
<help><![CDATA[
Performs a case-insensitive comparison of two strings.
An indicator of the difference:
A negative number, if string1 is less than string2
0, if string1 is equal to string2
A positive number, if string1 is greater than string2
]]></help>
<parameter name="string1" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="string2" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric Cos(number)
-->
<function name="cos" returns="Numeric" >
<help><![CDATA[
Calculates the cosine of an angle that is entered
in radians.
A number; the cosine of the angle.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
DateTime CreateDate(year, month, day)
-->
<function name="createDate" returns="DateTime" >
<help><![CDATA[
Creates a date/time object
]]></help>
<parameter name="year" required="true" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="year(now())"/>
</values>
</parameter>
<parameter name="month" required="true" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="month(now())"/>
</values>
</parameter>
<parameter name="day" required="true" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="day(now())"/>
</values>
</parameter>
</function>
<!--
DateTime CreateDateTime(year, month, day, hour, minute, second)
-->
<function name="createDateTime" returns="DateTime" >
<help><![CDATA[
Creates a date-time object.
]]></help>
<parameter name="year" required="true" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="year(now())"/>
</values>
</parameter>
<parameter name="month" required="true" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="month(now())"/>
</values>
</parameter>
<parameter name="day" required="true" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="day(now())"/>
</values>
</parameter>
<parameter name="hour" required="true" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="hour(now())"/>
</values>
</parameter>
<parameter name="minute" required="true" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="minute(now())"/>
</values>
</parameter>
<parameter name="second" required="true" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="second(now())"/>
</values>
</parameter>
</function>
<!--
CreateObject(type, class, context, serverName)
CreateObject(type, component-name)
CreateObject(type, context, class, locale)
CreateObject(type, class)
CreateObject(type, urltowsdl [, portname])
-->
<function name="createObject" returns="Object" >
<help><![CDATA[
The CreateObject function takes different arguments depending on the value of the first argument:
CreateObject('com', class, context, serverName)
CreateObject('component', component-name)
CreateObject('corba', context, class, locale)
CreateObject('java', class)
CreateObject('webservice', urltowsdl, [, portname])
]]></help>
<parameter name="type" required="true" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="component"/>
<value option="corba"/>
<value option="com"/>
<value option="java"/>
<value option="webservice"/>
</values>
</parameter>
<parameter name="context" required="true" type="String">
<help><![CDATA[
]]></help>
<triggers>
<selectedValue attributeName="type" index="1"
required="true" value="corba"/>
<selectedValue attributeName="type" index="2"
required="true" value="com"/>
</triggers>
</parameter>
<parameter name="class" required="true" type="String">
<help><![CDATA[
]]></help>
<triggers>
<selectedValue attributeName="type" index="1"
required="true" value="com"/>
<selectedValue attributeName="type" index="2"
required="true" value="corba"/>
<selectedValue attributeName="type" index="1"
required="true" value="java"/>
</triggers>
</parameter>
<parameter name="locale" required="true" type="String">
<help><![CDATA[
]]></help>
<triggers>
<selectedValue attributeName="type" index="3"
required="true" value="corba"/>
</triggers>
</parameter>
<parameter name="servername" required="true" type="String">
<help><![CDATA[
]]></help>
<triggers>
<selectedValue attributeName="type" index="3"
required="true" value="com"/>
</triggers>
</parameter>
<parameter name="component_name" required="true" type="String">
<help><![CDATA[
]]></help>
<triggers>
<selectedValue attributeName="type" index="1"
required="true" value="component"/>
</triggers>
</parameter>
<parameter name="urltowsdl" required="true" type="String">
<help><![CDATA[
WSDL file URL; location of web service
]]></help>
<triggers>
<selectedValue attributeName="type" index="1"
required="true" value="webservice"/>
</triggers>
</parameter>
<parameter name="portname" required="false" type="String">
<help><![CDATA[
The port name for the web service. This value is case-sensitive
and corresponds to the port element's name attribute under the
service element.
Specify this parameter if the web service contains multiple ports.
If no port name is specified, ColdFusion uses the first port found
in the WSDL.
]]></help>
<triggers>
<selectedValue attributeName="type" index="1"
required="true" value="webservice"/>
</triggers>
</parameter>
</function>
<!--
ODBCDate CreateODBCDate(date)
-->
<function name="createODBCDate" returns="ODBCDate" >
<help><![CDATA[
Creates an ODBC date object.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
ODBCDateTime CreateODBCDateTime(date)
-->
<function name="createODBCDateTime" returns="ODBCDateTime" >
<help><![CDATA[
Creates an ODBC date-time object.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
ODBCTime CreateODBCTime(date)
-->
<function name="createODBCTime" returns="ODBCTime" >
<help><![CDATA[
Creates an ODBC time object.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
DateTime CreateTime(hour, minute, second)
-->
<function name="createTime" returns="DateTime" >
<help><![CDATA[
Creates a time variable.
]]></help>
<parameter name="hour" required="true" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="hour(now())"/>
</values>
</parameter>
<parameter name="minute" required="true" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="minute(now())"/>
</values>
</parameter>
<parameter name="second" required="true" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="second(now())"/>
</values>
</parameter>
</function>
<!--
DateTime CreateTimeSpan(days, hours, minutes, seconds)
-->
<function name="createTimespan" returns="DateTime" >
<help><![CDATA[
Creates a date/time object that defines a time period. You
can add or subtract it from other date/time objects and use
it with the cachedWithin attribute of cfquery.
]]></help>
<parameter name="days" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="hours" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="minutes" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="seconds" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
UUID CreateUUID()
-->
<function name="createUUID" returns="UUID" >
<help><![CDATA[
Creates a Universally Unique Identifier (UUID). A UUID is a
35-character string representation of a unique 128-bit integer
xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx : x is a hexadecimal digit
]]></help>
</function>
<!--
DateTime DateAdd("datepart", number, "date")
-->
<function name="dateAdd" returns="DateTime" >
<help><![CDATA[
Adds units of time to a date.
[datepart - quicky]
yyyy: Year; q: Quarter; m: Month; y: Day of year; d: Day
w: Weekday; ww: Week; h: Hour; n: Minute; s: Second;
l: Millisecond
]]></help>
<parameter name="datepart" required="true" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="yyyy"/>
<value option="q"/>
<value option="m"/>
<value option="y"/>
<value option="d"/>
<value option="w"/>
<value option="ww"/>
<value option="h"/>
<value option="n"/>
<value option="s"/>
<value option="l"/>
</values>
</parameter>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
Numeric DateCompare("date1", "date2" [, "datePart"])
-->
<function name="dateCompare" returns="Numeric" >
<help><![CDATA[
Performs a full date/time comparison of two dates.
-1, if date1 is less than date2
0, if date1 is equal to date2
1, if date1 is greater than date2
[datepart - quicky]
yyyy: Year; q: Quarter; m: Month; y: Day of year; d: Day
w: Weekday; ww: Week; h: Hour; n: Minute; s: Second;
l: Millisecond
]]></help>
<parameter name="date1" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
<parameter name="date2" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
<parameter name="datePart" required="false" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="yyyy"/>
<value option="q"/>
<value option="m"/>
<value option="y"/>
<value option="d"/>
<value option="w"/>
<value option="ww"/>
<value option="h"/>
<value option="n"/>
<value option="s"/>
<value option="l"/>
</values>
</parameter>
</function>
<!--
DateTime DateConvert("conversion-type", "date")
-->
<function name="dateConvert" returns="DateTime" >
<help><![CDATA[
Converts local time to Coordinated Universal Time (UTC), or UTC
to local time. The function uses the daylight savings settings
in the executing computer to compute daylight savings time, if
required.
[type - quicky]
local2Utc: Converts local time to UTC time.
utc2Local: Converts UTC time to local time
]]></help>
<parameter name="type" required="true" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="local2Utc"/>
<value option="utc2Local"/>
</values>
</parameter>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
Numeric DateDiff("datepart", "date1", "date2")
-->
<function name="dateDiff" returns="Numeric" >
<help><![CDATA[
Determines the integer number of units by which date1 is less
than date2.
[datepart - quicky]
yyyy: Year; q: Quarter; m: Month; y: Day of year; d: Day
w: Weekday; ww: Week; h: Hour; n: Minute; s: Second;
l: Millisecond
]]></help>
<parameter name="datepart" required="true" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="yyyy"/>
<value option="q"/>
<value option="m"/>
<value option="y"/>
<value option="d"/>
<value option="w"/>
<value option="ww"/>
<value option="h"/>
<value option="n"/>
<value option="s"/>
<value option="l"/>
</values>
</parameter>
<parameter name="date1" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
<parameter name="date2" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
String DateFormat("date" [, "mask" ])
-->
<function name="dateFormat" returns="String" >
<help><![CDATA[
Formats a date value using U.S. date formats. For
international date support, use LSDateFormat.
[mask - quicky]
d,dd,ddd,dddd: Day of month / week
m,mm,mmm,mmmm: Month; y,yy,yyyy: Year; gg: Period/era string
short / medium / long / full
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
<parameter name="mask" required="false" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="short"/>
<value option="medium"/>
<value option="long"/>
<value option="full"/>
</values>
</parameter>
</function>
<!--
Numeric DatePart("datepart", "date")
-->
<function name="datePart" returns="Numeric" >
<help><![CDATA[
Extracts a part from a date value as a numeric.
[datepart - quicky]
yyyy: Year; q: Quarter; m: Month; y: Day of year; d: Day
w: Weekday; ww: Week; h: Hour; n: Minute; s: Second;
l: Millisecond
]]></help>
<parameter name="datepart" required="true" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="yyyy"/>
<value option="q"/>
<value option="m"/>
<value option="y"/>
<value option="d"/>
<value option="w"/>
<value option="ww"/>
<value option="h"/>
<value option="n"/>
<value option="s"/>
<value option="l"/>
</values>
</parameter>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
Numeric Day(date)
-->
<function name="day" returns="Numeric" >
<help><![CDATA[
Determines the day of the month, in a date.
The ordinal for the day of the month, ranging from 1 to 31.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
Numeric DayOfWeek(date)
-->
<function name="dayOfWeek" returns="Numeric" >
<help><![CDATA[
Determines the day of the week, in a date.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
String DayOfWeekAsString(day_of_week)
-->
<function name="dayOfWeekAsString" returns="String" >
<help><![CDATA[
Determines the day of the week as a string from 1-7
]]></help>
<parameter name="day_of_week" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric DayOfYear(date)
-->
<function name="dayOfYear" returns="Numeric" >
<help><![CDATA[
Determines the day of the year, in a date.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
Numeric DaysInMonth(date)
-->
<function name="daysInMonth" returns="Numeric" >
<help><![CDATA[
Determines the number of days in a month.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
Numeric DaysInYear(date)
-->
<function name="daysInYear" returns="Numeric" >
<help><![CDATA[
Determines the number of days in a year.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
Object DE(string)
-->
<function name="de" returns="Object" >
<help><![CDATA[
Postpones evaluation of a string as an expression, when it is
passed as a parameter to the IIf or Evaluate functions. Escapes
any double quotation marks in the parameter and wraps the
result in double quotation marks.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String DecimalFormat(number)
-->
<function name="decimalFormat" returns="String" >
<help><![CDATA[
Converts a number to a decimal-formatted string.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric DecrementValue(number)
-->
<function name="decrementValue" returns="Numeric" >
<help><![CDATA[
Decrements the integer part of a number.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String Decrypt(encrypted_string, key[, algorithm[, encoding[, IVorSalt[, iterations]]]])
-->
<function name="decrypt" returns="String" >
<help><![CDATA[
Decrypts a string that is encrypted with the Encrypt function.
]]></help>
<parameter name="encrypted_string" required="true" type="String">
<help><![CDATA[
String to decrypt.
]]></help>
</parameter>
<parameter name="key" required="true" type="String">
<help><![CDATA[
Key or seed used to encrypt the string.
* For the CFMX_COMPAT algorithm, any combination of any
number of characters; used as a seed used to generate
a 32-bit encryption key.
* For all other algorithms, a key in the format used by the
algorithm. For these algorithms, use the GenerateSecretKey
function to generate the key.
]]></help>
</parameter>
<parameter name="algorithm" required="false" type="String">
<help><![CDATA[
The algorithm to use to decrypt the string. Must be the same
as the algorithm used to encrypt the string.
* CFMX_COMPAT: the algorithm used in ColdFusion MX and prior
releases. This algorithm is the least secure option (default).
* AES: the Advanced Encryption Standard specified by the
National Institute of Standards and Technology (NIST) FIPS-197.
* BLOWFISH: the Blowfish algorithm defined by Bruce Schneier.
* DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.
* DESEDE: the "Triple DES" algorithm defined by NIST FIPS-46-3.
]]></help>
<values default="CFMX_COMPAT">
<value option="CFMX_COMPAT"/>
<value option="AES"/>
<value option="BLOWFISH"/>
<value option="DES"/>
<value option="DESEDE"/>
</values>
</parameter>
<parameter name="encoding" required="false" type="String">
<help><![CDATA[
The binary encoding used to represent the data as a string.
Must be the same as the algorithm used to encrypt the string.
* Base64: the Base64 algorithm, as specified by IETF RFC 2045.
* Hex: the characters A-F and 0-9 represent the hexadecimal byte values.
* UU: the UNIX standard UUEncode algorithm (default).
If you specify this parameter, you must also specify the algorithm parameter.
]]></help>
<values default="UU">
<value option="UU"/>
<value option="Base64"/>
<value option="Hex"/>
</values>
</parameter>
<parameter name="ivorsalt" required="false" type="Binary">
<help><![CDATA[
Specify this parameter to adjust ColdFusion encryption to match
the details of other encryption software. If you specify this
parameter, you must also specify the algorithm parameter.
* For Block Encryption Algorithms: This is the binary
Initialization Vector value to use with the algorithm. The
algorithm must contain a Feedback Mode other than ECB. This
must be a binary value that is exactly the same size as the
algorithm block size.
* For Password Based Encryption Algorithms: This is the binary
Salt value to transform the password into a key.
]]></help>
</parameter>
<parameter name="iterations" required="false" type="Numeric">
<help><![CDATA[
The number of iterations to transform the password into a
binary key. Specify this parameter to adjust ColdFusion
encryption to match the details of other encryption software.
If you specify this parameter, you must also specify the
algorithm parameter with a Password Based Encryption (PBE)
algorithm. Do not specify this parameter for Block Encryption
Algorithms. You must use the same value to encrypt and
decrypt the data.
* For Password Based Encryption Algorithms: This is the
binary Salt value to transform the password into a key.
]]></help>
</parameter>
</function>
<function name="decryptBinary" returns="String" >
<help><![CDATA[
Decrypts encrypted binary data with the specified key, value, algorithm, salt, and iterations.
]]></help>
<parameter name="bytes" required="true" type="String">
<help><![CDATA[
Binary data to decrypt.
]]></help>
</parameter>
<parameter name="key" required="true" type="String">
<help><![CDATA[
Key or seed used to encrypt the string.
* For the CFMX_COMPAT algorithm, any combination of any
number of characters; used as a seed used to generate
a 32-bit encryption key.
* For all other algorithms, a key in the format used by the
algorithm. For these algorithms, use the GenerateSecretKey
function to generate the key.
]]></help>
</parameter>
<parameter name="algorithm" required="false" type="String">
<help><![CDATA[
The algorithm to use to decrypt the string. Must be the same
as the algorithm used to encrypt the string.
* CFMX_COMPAT: the algorithm used in ColdFusion MX and prior
releases. This algorithm is the least secure option (default).
* AES: the Advanced Encryption Standard specified by the
National Institute of Standards and Technology (NIST) FIPS-197.
* BLOWFISH: the Blowfish algorithm defined by Bruce Schneier.
* DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.
* DESEDE: the "Triple DES" algorithm defined by NIST FIPS-46-3.
]]></help>
<values default="CFMX_COMPAT">
<value option="CFMX_COMPAT"/>
<value option="AES"/>
<value option="BLOWFISH"/>
<value option="DES"/>
<value option="DESEDE"/>
</values>
</parameter>
<parameter name="ivorsalt" required="false" type="Binary">
<help><![CDATA[
Specify this parameter to adjust ColdFusion encryption to match
the details of other encryption software. If you specify this
parameter, you must also specify the algorithm parameter.
* For Block Encryption Algorithms: This is the binary
Initialization Vector value to use with the algorithm. The
algorithm must contain a Feedback Mode other than ECB. This
must be a binary value that is exactly the same size as the
algorithm block size.
* For Password Based Encryption Algorithms: This is the binary
Salt value to transform the password into a key.
]]></help>
</parameter>
<parameter name="iterations" required="false" type="Numeric">
<help><![CDATA[
The number of iterations to transform the password into a
binary key. Specify this parameter to adjust ColdFusion
encryption to match the details of other encryption software.
If you specify this parameter, you must also specify the
algorithm parameter with a Password Based Encryption (PBE)
algorithm. Do not specify this parameter for Block Encryption
Algorithms. You must use the same value to encrypt and
decrypt the data.
* For Password Based Encryption Algorithms: This is the
binary Salt value to transform the password into a key.
]]></help>
</parameter>
</function>
<!--
boolean DeleteClientVariable("name")
-->
<function name="deleteClientVariable" returns="boolean" >
<help><![CDATA[
Deletes a client variable. (To test for the existence of a
variable, use IsDefined.)
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="deserializeJSON" returns="Any" >
<help><![CDATA[
Converts a JSON (JavaScript Object Notation) string data representation into CFML data, such as a CFML structure or array.
]]></help>
<parameter name="jsonvar" required="true" type="String">
<help><![CDATA[
A string that contains a valid JSON construct, or variable that represents one.
]]></help>
</parameter>
<parameter name="strictmapping" required="false" type="boolean">
<help><![CDATA[
A Boolean value that specifies whether to convert the JSON strictly.
]]></help>
</parameter>
</function>
<!--
boolean DirectoryExists(absolute_path)
-->
<function name="directoryExists" returns="boolean" >
<help><![CDATA[
Determines whether a directory exists.
]]></help>
<parameter name="absolute_path" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="directoryCreate" returns="void" >
<help><![CDATA[
Creates new directory for specified path
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="directoryList" returns="Object" >
<help><![CDATA[
Lists the directory and returns the list of files under it as array or query
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="recurse" required="false" type="Boolean">
<help><![CDATA[
]]></help>
<values default="false">
<value option="true" />
<value option="false" />
</values>
</parameter>
<parameter name="returnType" required="false" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="filter" required="false" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="sort" required="false" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="directoryDelete" returns="void" >
<help><![CDATA[
Deltes directory for given path
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="recurse" required="true" type="Boolean">
<help><![CDATA[
]]></help>
<values default="false">
<value option="true" />
<value option="false" />
</values>
</parameter>
</function>
<function name="directoryRename" returns="void" >
<help><![CDATA[
Renames given directory
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="newPath" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="directorySize" returns="Numeric" >
<help><![CDATA[
Returns size of given directory
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String DollarFormat(number)
-->
<function name="dollarFormat" returns="String" >
<help><![CDATA[
Formats a string in U.S. format. (For other currencies, use
LSCurrencyFormat or LSEuroCurrencyFormat.)
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Object Duplicate(variable_name)
-->
<function name="dotnetToCFType" returns="Any" >
<help><![CDATA[
Explicitly converts a value returned by a .NET method to the corresponding ColdFusion data type.
]]></help>
<parameter name="variable_name" required="true" type="Varible">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="duplicate" returns="Object" >
<help><![CDATA[
Returns a clone, also known as a deep copy, of a variable
or XML object. There is no reference to the original variable.
]]></help>
<parameter name="variable" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String Encrypt(string, key[, algorithm[, encoding[, IVorSalt[, iterations]]]]))
-->
<function name="encrypt" returns="String" >
<help><![CDATA[
Encrypts a string. Uses a symmetric key-based algorithm, in
which the same key is used to encrypt and decrypt a string.
The security of the encrypted string depends on maintaining
the secrecy of the key. Uses an XOR-based algorithm that uses
a pseudo-random 32-bit key, based on a seed passed by the user
as a function parameter.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
String to encrypt.
]]></help>
</parameter>
<parameter name="key" required="true" type="String">
<help><![CDATA[
Key or seed used to encrypt the string.
* For the CFMX_COMPAT algorithm, any combination of any
number of characters; used as a seed used to generate
a 32-bit encryption key.
* For all other algorithms, a key in the format used by the
algorithm. For these algorithms, use the GenerateSecretKey
function to generate the key.
]]></help>
</parameter>
<parameter name="algorithm" required="false" type="String">
<help><![CDATA[
The algorithm to use to encrypt the string.
* CFMX_COMPAT: the algorithm used in ColdFusion MX and prior
releases. This algorithm is the least secure option (default).
* AES: the Advanced Encryption Standard specified by the
National Institute of Standards and Technology (NIST) FIPS-197.
* BLOWFISH: the Blowfish algorithm defined by Bruce Schneier.
* DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.
* DESEDE: the "Triple DES" algorithm defined by NIST FIPS-46-3.
]]></help>
<values default="CFMX_COMPAT">
<value option="CFMX_COMPAT"/>
<value option="AES"/>
<value option="BLOWFISH"/>
<value option="DES"/>
<value option="DESEDE"/>
</values>
</parameter>
<parameter name="encoding" required="false" type="String">
<help><![CDATA[
The binary encoding used to represent the data as a string.
Must be the same as the algorithm used to encrypt the string.
* Base64: the Base64 algorithm, as specified by IETF RFC 2045.
* Hex: the characters A-F and 0-9 represent the hexadecimal byte values.
* UU: the UNIX standard UUEncode algorithm (default).
If you specify this parameter, you must also specify the algorithm parameter.
]]></help>
<values default="UU">
<value option="UU"/>
<value option="Base64"/>
<value option="Hex"/>
</values>
</parameter>
<parameter name="ivorsalt" required="false" type="Binary">
<help><![CDATA[
Specify this parameter to adjust ColdFusion encryption to match
the details of other encryption software. If you specify this
parameter, you must also specify the algorithm parameter.
* For Block Encryption Algorithms: This is the binary
Initialization Vector value to use with the algorithm. The
algorithm must contain a Feedback Mode other than ECB. This
must be a binary value that is exactly the same size as the
algorithm block size.
* For Password Based Encryption Algorithms: This is the binary
Salt value to transform the password into a key.
]]></help>
</parameter>
<parameter name="iterations" required="false" type="Numeric">
<help><![CDATA[
The number of iterations to transform the password into a
binary key. Specify this parameter to adjust ColdFusion
encryption to match the details of other encryption software.
If you specify this parameter, you must also specify the
algorithm parameter with a Password Based Encryption (PBE)
algorithm. Do not specify this parameter for Block Encryption
Algorithms. You must use the same value to encrypt and
decrypt the data.
* For Password Based Encryption Algorithms: This is the
binary Salt value to transform the password into a key.
]]></help>
</parameter>
</function>
<function name="encryptBinary" returns="String" >
<help><![CDATA[
Encrypts binary data using a specific algorithm and encoding method.
]]></help>
<parameter name="bytes" required="true" type="String">
<help><![CDATA[
Bindary data to encrypt.
]]></help>
</parameter>
<parameter name="key" required="true" type="String">
<help><![CDATA[
Key or seed used to encrypt the string.
* For the CFMX_COMPAT algorithm, any combination of any
number of characters; used as a seed used to generate
a 32-bit encryption key.
* For all other algorithms, a key in the format used by the
algorithm. For these algorithms, use the GenerateSecretKey
function to generate the key.
]]></help>
</parameter>
<parameter name="algorithm" required="false" type="String">
<help><![CDATA[
The algorithm to use to encrypt the string.
* CFMX_COMPAT: the algorithm used in ColdFusion MX and prior
releases. This algorithm is the least secure option (default).
* AES: the Advanced Encryption Standard specified by the
National Institute of Standards and Technology (NIST) FIPS-197.
* BLOWFISH: the Blowfish algorithm defined by Bruce Schneier.
* DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.
* DESEDE: the "Triple DES" algorithm defined by NIST FIPS-46-3.
]]></help>
<values default="CFMX_COMPAT">
<value option="CFMX_COMPAT"/>
<value option="AES"/>
<value option="BLOWFISH"/>
<value option="DES"/>
<value option="DESEDE"/>
</values>
</parameter>
<parameter name="ivorsalt" required="false" type="Binary">
<help><![CDATA[
Specify this parameter to adjust ColdFusion encryption to match
the details of other encryption software. If you specify this
parameter, you must also specify the algorithm parameter.
* For Block Encryption Algorithms: This is the binary
Initialization Vector value to use with the algorithm. The
algorithm must contain a Feedback Mode other than ECB. This
must be a binary value that is exactly the same size as the
algorithm block size.
* For Password Based Encryption Algorithms: This is the binary
Salt value to transform the password into a key.
]]></help>
</parameter>
<parameter name="iterations" required="false" type="Numeric">
<help><![CDATA[
The number of iterations to transform the password into a
binary key. Specify this parameter to adjust ColdFusion
encryption to match the details of other encryption software.
If you specify this parameter, you must also specify the
algorithm parameter with a Password Based Encryption (PBE)
algorithm. Do not specify this parameter for Block Encryption
Algorithms. You must use the same value to encrypt and
decrypt the data.
* For Password Based Encryption Algorithms: This is the
binary Salt value to transform the password into a key.
]]></help>
</parameter>
</function>
<!--
Object Evaluate(string_expression1 [, string_expression2 [, ... ] ] )
-->
<function name="evaluate" returns="Object" >
<help><![CDATA[
Evaluates one or more string expressions, dynamically, from
left to right. (The results of an evaluation on the left can
have meaning in an expression to the right.) Returns the
result of evaluating the rightmost expression.
]]></help>
<parameter name="expression1" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="expression2" required="false" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="expressionN" required="false" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric Exp(number)
-->
<function name="exp" returns="Numeric" >
<help><![CDATA[
Calculates the exponent whose base is e that represents number.
The constant e equals 2.71828182845904, the base of the natural
logarithm. This function is the inverse of Log, the natural
logarithm of number.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String ExpandPath(relative_path)
-->
<function name="expandPath" returns="String" >
<help><![CDATA[
Creates an absolute, platform-appropriate path that is
equivalent to the value of relative_path, appended to the base
path. This function (despite its name) can accept an absolute
or relative path in the relative_path attribute
]]></help>
<parameter name="relative_path" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean FileExists(absolute_path)
-->
<function name="fileExists" returns="boolean" >
<help><![CDATA[
Determines whether a file exists
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="fileIsEOF" returns="boolean" >
<help><![CDATA[
Determines whether ColdFusion has reached the end of the file while reading it.
]]></help>
<parameter name="fileObject" required="true" type="Object">
<help><![CDATA[
The file object.
]]></help>
</parameter>
</function>
<!--
Numeric Find(substring, string [, start ])
-->
<function name="find" returns="Numeric" >
<help><![CDATA[
Finds the first occurrence of a substring in a string, from a
specified start position. The search is case-sensitive.
]]></help>
<parameter name="substring" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="start" required="false" type="Numeric">
<help><![CDATA[
]]></help>
<values default="1">
<value option="1"/>
</values>
</parameter>
</function>
<!--
Numeric FindNoCase(substring, string [, start ])
-->
<function name="findNoCase" returns="Numeric" >
<help><![CDATA[
Finds the first occurrence of a substring in a string, from a
specified start position. If substring is not in string,
returns zero. The search is case-insensitive.
]]></help>
<parameter name="substring" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="start" required="false" type="Numeric">
<help><![CDATA[
]]></help>
<values default="1">
<value option="1"/>
</values>
</parameter>
</function>
<!--
Numeric FindOneOf(set, string [, start ])
-->
<function name="findOnEOF" returns="Numeric" >
<help><![CDATA[
Finds the first occurrence of any one of a set of characters
in a string, from a specified start position. The search is
case-sensitive.
]]></help>
<parameter name="set" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="start" required="false" type="Numeric">
<help><![CDATA[
]]></help>
<values default="1">
<value option="1"/>
</values>
</parameter>
</function>
<!--
Numeric FirstDayOfMonth(date)
-->
<function name="firstDayOfMonth" returns="Numeric" >
<help><![CDATA[
Determines the ordinal (day number, in the year) of the first
day of the month in which a given date falls.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
Numeric Fix(number)
-->
<function name="fix" returns="Numeric" >
<help><![CDATA[
Converts a real number to an integer.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String FormatBaseN(number, radix)
-->
<function name="formatBaseN" returns="String" >
<help><![CDATA[
String Converts number to a string, in the base specified by
radix. For example: #FormatBaseN(1024,16)#
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="radix" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String GenerateSecretKey(algorithm)
-->
<function name="generateSecretKey" returns="String" >
<help><![CDATA[
Gets a secure key value for use in the encrypt function.
]]></help>
<parameter name="algorithm" required="false" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="CFMX_COMPAT"/>
<value option="AES"/>
<value option="BLOWFISH"/>
<value option="DES"/>
<value option="DESEDE"/>
</values>
</parameter>
</function>
<!--
String GetAuthUser()
-->
<function name="getAuthUser" returns="String" >
<help><![CDATA[
Gets the name of an authenticated user.
]]></help>
</function>
<!--
Object GetBaseTagData(tagname [, instancenumber ] )
-->
<function name="getBaseTagData" returns="Object" >
<help><![CDATA[
Used within a custom tag. Finds calling (ancestor) tag by
name and accesses its data.
]]></help>
<parameter name="tagname" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="instancenumber" required="false" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String GetBaseTagList()
-->
<function name="getBaseTagList" returns="String" >
<help><![CDATA[
Gets ancestor tag names, starting with the parent tag.
]]></help>
</function>
<!--
String GetBaseTemplatePath()
-->
<function name="getBaseTemplatePath" returns="String" >
<help><![CDATA[
Gets the absolute path of an application's base page.
]]></help>
</function>
<!--
String GetClientVariablesList()
-->
<function name="getClientVariablesList" returns="String" >
<help><![CDATA[
Finds the client variables to which a page has write access.
Comma-delimited list of non-read-only client variables
]]></help>
</function>
<function name="getComponentMetadata" returns="Struct" >
<help><![CDATA[
Gets metadata (such as the functions and implemented interfaces of a component) for a CFC or ColdFusion interface.
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
The dot-delimited path of the interface or CFC definition.
]]></help>
</parameter>
</function>
<!--
String GetContextRoot()
-->
<function name="getContextRoot" returns="String" >
<help><![CDATA[
Returns path to the J2EE server context root for the current request.
]]></help>
</function>
<!--
String GetCurrentTemplatePath()
-->
<function name="getCurrentTemplatePath" returns="String" >
<help><![CDATA[
Gets the absolute path of the page that calls this function.
]]></help>
</function>
<!--
String GetDirectoryFromPath(path)
-->
<function name="getDirectoryFromPath" returns="String" >
<help><![CDATA[
Extracts a directory from an absolute path.
Returns the absolute path, without the filename.
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String GetEncoding(scope_name)
-->
<function name="getEncoding" returns="String" >
<help><![CDATA[
Returns the encoding (character set) of the Form or URL scope.
]]></help>
<parameter name="scope_name" required="true" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="form"/>
<value option="url"/>
</values>
</parameter>
</function>
<!--
Object getException(object)
-->
<function name="getException" returns="Object" >
<help><![CDATA[
Used with the cftry and cfcatch tags. Retrieves a Java
exception object from a Java object.
]]></help>
<parameter name="javaobject" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String GetFileFromPath(path)
-->
<function name="getFileFromPath" returns="String" >
<help><![CDATA[
Extracts a filename from an absolute path.
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Struct GetFunctionList()
-->
<function name="getFunctionList" returns="Struct" >
<help><![CDATA[
Displays a list of the functions that are available in
CFML.
]]></help>
</function>
<!--
Object GetGatewayHelper(gatewayID)
-->
<function name="getGatewayHelper" returns="Object" >
<help><![CDATA[
Gets a Java GatewayHelper object that provides methods
and properties for use with a ColdFusion event gateway.
]]></help>
<parameter name="gatewayID" required="true" type="String">
<help><![CDATA[
Identifier of the gateway that provides the GatewayHelper object.
]]></help>
</parameter>
</function>
<!--
Struct GetHttpRequestData()
-->
<function name="getHTTPRequestData" returns="Struct" >
<help><![CDATA[
Makes HTTP request headers and body available to CFML pages.
Useful for capturing SOAP request data, which can be delivered
in an HTTP header.
]]></help>
</function>
<!--
String GetHttpTimeString(date_time_object)
-->
<function name="getHTTPTimeString" returns="String" >
<help><![CDATA[
Gets the current time, in the Universal Time code (UTC).
]]></help>
<parameter name="DateTime" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
Numeric GetK2ServerDocCount()
-->
<function compatibility="deprecated" name="getK2ServerDocCount"
returns="Numeric" >
<help><![CDATA[
This function is deprecated.
Determines the number of documents that can be searched by the
CFML registered K2 Server. This function is used
primarily by the CFML Verity and K2Server Administrator
pages, and requires significant processing time. Avoid using
it in production applications. This function uses Verity
K2Server Release K2.2.0.
]]></help>
</function>
<!--
Numeric GetK2ServerDocCountLimit()
-->
<function compatibility="deprecated"
name="getK2ServerDoccountLimit" returns="Numeric" >
<help><![CDATA[
This function is deprecated.
Gets the maximum number of documents that the CFML
registered K2 Server is permitted to return from a search.
This function is used primarily by the CFML Verity and
K2Server Administrator pages. This function uses Verity
K2Server Release K2.2.0.
]]></help>
</function>
<!--
String GetLocale()
-->
<function name="getLocale" returns="String" >
<help><![CDATA[
Gets the current geographic/language locale value.
To set the default display format of date, time, number, and
currency values in a CFML application session, you use
the SetLocale function.
]]></help>
</function>
<!--
String GetLocaleDisplayName([locale[, inLocale]])
-->
<function name="getLocaleDisplayName" returns="String" >
<help><![CDATA[
Gets a locale value and displays the name in a manner
that is appropriate to a specific locale. By default,
gets the current locale in the current locale's language.
]]></help>
</function>
<function name="getLocalhostIP" returns="String" >
<help><![CDATA[
Returns the localhost IP address, which is 127.0.0.1 for IPv4 and ::1 for IPv6 addresses.
]]></help>
</function>
<!--
Object GetMetaData(object)
-->
<function name="getMetadata" returns="Object" >
<help><![CDATA[
Gets metadata (the methods, properties, and parameters of a
component) associated with an object that is deployed on the
CFML server.
]]></help>
<parameter name="Object" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Object GetMetricData(mode)
-->
<function name="getMetricData" returns="Object" >
<help><![CDATA[
Gets server performance metrics
[mode - quicky]
perf_monitor - Returns internal data, in a structure.
simple_load - Returns an integer value that is computed
from the state of the server's internal
queues. Indicates the overall server load.
prev_req_time - Returns the time, in milliseconds, that it
took the server to process the previous
request.
avg_req_time - Returns the average time, in milliseconds,
that it takes the server to process a
request.
]]></help>
<parameter name="mode" required="true" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="perf_monitor"/>
<value option="simple_load"/>
<value option="prev_req_time"/>
<value option="avg_req_time"/>
</values>
</parameter>
</function>
<!--
Object GetPageContext()
-->
<function name="getPageContext" returns="Object" >
<help><![CDATA[
Gets the current CFML MX PageContext object that
provides access to page attributes and configuration, request
and response objects.
]]></help>
</function>
<!--
Struct GetProfileSections(iniFile)
-->
<function name="getProfileSections" returns="Struct" >
<help><![CDATA[
Gets all the sections of an initialization file.
An initialization file, as a struct whose format is as follows:
- Each initialization file section name is a key in the
struct
- Each list of entries in a section of an initialization
file is a value in the struct
]]></help>
<parameter name="inifile" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String GetProfileString(iniPath, section, entry)
-->
<function name="getProfileString" returns="String" >
<help><![CDATA[
Gets an initialization file entry.
An initialization file assigns values to configuration
variables, also known as entries, that are set when the system
boots, the operating system comes up, or an application starts.
Returns the entry - if no value, returns an empty string.
]]></help>
<parameter name="inipath" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="section" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="entry" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Object GetSOAPRequest()
-->
<function name="getSOAPRequest" returns="Object" >
<help><![CDATA[
Returns an XML object that contains the entire SOAP
request. Usually called from within a web service CFC.
]]></help>
</function>
<!--
Object GetSOAPRequestHeader(namespace, name [, asXML])
-->
<function name="getSOAPRequestHeader" returns="Object" >
<help><![CDATA[
Obtains a SOAP request header. Call only from within
a CFC web service function that is processing a request
as a SOAP web service.
]]></help>
<parameter name="namespace" required="true" type="String">
<help><![CDATA[
A String that is the namespace for the header
]]></help>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
A String that is the name of the header
]]></help>
</parameter>
<parameter name="asXML" required="false" type="boolean">
<help><![CDATA[
If True, the header is returned as a CFML XML object;
if false (default), the header is returned as a Java object.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</function>
<!--
Object GetSOAPResponse(webservice)
-->
<function name="getSOAPResponse" returns="Object" >
<help><![CDATA[
Returns an XML object that contains the entire
SOAP response after invoking a web service.
]]></help>
<parameter name="webservice" required="true" type="String">
<help><![CDATA[
A webservice object as returned from the cfobject
tag or the CreateObject function.
]]></help>
</parameter>
</function>
<!--
Object GetSOAPResponseHeader(webservice, namespace, name [, asXML])
-->
<function name="getSOAPResponseHeader" returns="Object" >
<help><![CDATA[
Returns a SOAP response header. Call this function
from within code that is invoking a web service after
making a web service request.
]]></help>
<parameter name="webservice" required="true" type="Object">
<help><![CDATA[
A webservice object as returned from the cfobject tag
or the Createobject function.
]]></help>
</parameter>
<parameter name="namespace" required="true" type="String">
<help><![CDATA[
A String that is the namespace for the header.
]]></help>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
A String that is the name of the SOAP header.
]]></help>
</parameter>
<parameter name="asXML" required="false" type="boolean">
<help><![CDATA[
If True, the header is returned as a CFML XML object;
if false (default), the header is returned as a Java object.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</function>
<!--
String GetTempDirectory()
-->
<function name="getTempDirectory" returns="String" >
<help><![CDATA[
Gets the path of the directory that CFML uses for
temporary files. Before using this function in an application,
test to determine the directory it returns under your account.
Returns the absolute pathname of a directory, including a
trailing slash.
]]></help>
</function>
<!--
String GetTempFile(dir, prefix)
-->
<function name="getTempFile" returns="String" >
<help><![CDATA[
Creates a temporary file in a directory whose name starts with
(at most) the first three characters of prefix.
]]></help>
<parameter name="dir" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="prefix" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
GetTemplatePath
-->
<function compatibility="deprecated" name="getTemplatePath"
returns="String" >
<help><![CDATA[
This function is deprecated.
Use the GetBaseTemplatePath function instead.
]]></help>
</function>
<!--
Numeric GetTickCount()
-->
<function name="getTickCount" returns="Numeric" >
<help><![CDATA[
Returns the current value of an internal millisecond timer.
]]></help>
</function>
<!--
Object GetTimeZoneInfo()
-->
<function name="getTimezoneInfo" returns="Object" >
<help><![CDATA[
Gets local time zone information for the computer on which it
is called, relative to Universal Time Coordinated (UTC). UTC is
the mean solar time of the meridian of Greenwich, England.
]]></help>
<parameter name="text" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String GetToken(string, index [, delimiters ])
-->
<function name="getToken" returns="String" >
<help><![CDATA[
Determines whether a token of the list in the delimiters
parameter is present in a string.
Returns the token found at position index of the string, as a
string. If index is greater than the number of tokens in the
string, returns an empty string.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="index" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values>
<value option=","/>
<value option="|"/>
<value option="_"/>
<value option=";"/>
<value option=":"/>
</values>
</parameter>
</function>
<function name="getUserRoles" returns="List" >
<help><![CDATA[
Retrieves the list of roles for the current user.
]]></help>
</function>
<function name="getVFSMetadata" returns="Struct" >
<help><![CDATA[
Returns metadata for VFS
]]></help>
<parameter name="fileSystemType" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String Hash(string[, algorithm[, encoding]] )
-->
<function name="hash" returns="String" >
<help><![CDATA[
Converts a variable-length string to a 32-byte, hexadecimal
string, using the MD5 algorithm. (It is not possible to convert
the hash result back to the source string.)
32-byte, hexadecimal string
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="algorithm" required="false" type="String">
<help><![CDATA[
]]></help>
<values default="CFMX_COMPAT">
<value option="CFMX_COMPAT"/>
<value option="MD5"/>
<value option="SHA"/>
<value option="SHA-256"/>
<value option="SHA-384"/>
<value option="SHA-512"/>
</values>
</parameter>
<parameter name="encoding" required="false" type="String">
<help><![CDATA[
A string specifying the encoding to use when converting
the string to byte data used by the hash algorithm.
Must be a character encoding name recognized by the
Java runtime.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
</parameter>
</function>
<!--
Numeric Hour(date)
-->
<function name="hour" returns="Numeric" >
<help><![CDATA[
Gets the current hour of the day.
Ordinal value of the hour, in the range 0 - 23.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
String HTMLCodeFormat(string [, version ])
-->
<function name="htmlCodeFormat" returns="String" >
<help><![CDATA[
Replaces special characters in a string with their HTML-escaped
equivalents and inserts <pre> and </pre> tags at the beginning
and end of the string.
[version]
HTML version to use. currently ignored.
-1: The latest implementation of HTML
2.0: HTML 2.0 (Default)
3.2: HTML 3.2
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="version" required="false" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="-1"/>
<value option="2.0"/>
<value option="3.2"/>
</values>
</parameter>
</function>
<!--
String HTMLEditFormat(string [, version ])
-->
<function name="htmlEditFormat" returns="String" >
<help><![CDATA[
Replaces special characters in a string with their
HTML-escaped equivalents.
[version]
HTML version to use. currently ignored.
-1: The latest implementation of HTML
2.0: HTML 2.0 (Default)
3.2: HTML 3.2
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="version" required="false" type="Numeric">
<help><![CDATA[
]]></help>
<values>
<value option="-1"/>
<value option="2.0"/>
<value option="3.2"/>
</values>
</parameter>
</function>
<!--
String IIf(condition, string_expression1, string_expression2)
-->
<function name="iIf" returns="String" >
<help><![CDATA[
Evaluates a Boolean conditional dynamic expression. Depending
on whether the expression is true or false, dynamically
evaluates one of two string expressions and returns the result.
]]></help>
<parameter name="condition" required="true" type="boolean">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="expression1" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="expression2" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric IncrementValue(number)
-->
<function name="incrementValue" returns="Numeric" >
<help><![CDATA[
Adds one to an integer. same as x=x+1
Why bother?
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric InputBaseN(string, radix)
-->
<function name="inputBaseN" returns="Numeric" >
<help><![CDATA[
Converts string, using the base specified by radix, to an
integer. For example: #InputBaseN("3ff",16)#
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="radix" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String Insert(substring, string, position)
-->
<function name="insert" returns="String" >
<help><![CDATA[
Inserts a substring in a string after a specified character
position. If position = 0, prefixes the substring to the
string.
]]></help>
<parameter name="substring" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="position" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric Int(number)
-->
<function name="int" returns="Numeric" >
<help><![CDATA[
Calculates the closest integer that is smaller than number.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsArray(value [, number ])
-->
<function name="isArray" returns="boolean" >
<help><![CDATA[
Determines whether a value is an array.
True, if value is an array, a query column object, or xml.
also number = Dimension; function tests whether the array has
exactly this dimension
]]></help>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="number" required="false" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsBinary(value)
-->
<function name="isBinary" returns="boolean" >
<help><![CDATA[
Determines whether a value is stored as binary data.
]]></help>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsBoolean(value)
-->
<function name="isBoolean" returns="boolean" >
<help><![CDATA[
Determines whether a value can be converted to Boolean
]]></help>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsCustomFunction(name)
-->
<function name="isCustomFunction" returns="boolean" >
<help><![CDATA[
Determines whether a name represents a custom function
]]></help>
<parameter name="Object" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsDate(string)
-->
<function name="isDate" returns="boolean" >
<help><![CDATA[
Determines whether a string or Java object can be converted
to a date/time value.
]]></help>
<parameter name="Object" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="isDDX" returns="boolean" >
<help><![CDATA[
Determines whether a DDX file exists and is valid, or if a string contains valid DDX instructions.
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
Pathname to the DDX file or a string of DDX instructions.
]]></help>
</parameter>
</function>
<!--
boolean IsDebugMode()
-->
<function name="isDebugMode" returns="boolean" >
<help><![CDATA[
Determines whether debugging output is enabled.
]]></help>
</function>
<function name="isInstanceOf" returns="boolean" >
<help><![CDATA[
Determines whether an object is an instance of a Coldfusion interface or component, or of a Java class.
]]></help>
<parameter name="object" required="true" type="Object">
<help><![CDATA[
The CFC instance or Java object that you are testing
]]></help>
</parameter>
<parameter name="typename" required="true" type="String">
<help><![CDATA[
The name of the interface, component, or Java class of which the object might be an instance
]]></help>
</parameter>
</function>
<function name="isJSON" returns="boolean" >
<help><![CDATA[
Evaluates whether a string is in valid JSON (JavaScript Object Notation) data interchange format.
]]></help>
<parameter name="var" required="true" type="String">
<help><![CDATA[
A string or variable that represents one.
]]></help>
</parameter>
</function>
<!--
boolean IsDefined("variable_name")
-->
<function name="isDefined"
returns="boolean" >
<help><![CDATA[
Evaluates a string value to determine whether the variable
named in it exists.
]]></help>
<parameter name="variable_name" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsK2ServerABroker()
-->
<!--
boolean IsK2ServerDocCountExceeded()
-->
<!--
boolean IsK2ServerOnline()
-->
<!--
boolean IsLeapYear(year)
-->
<function name="isLeapYear" returns="boolean" >
<help><![CDATA[
Determines whether a year is a leap year.
]]></help>
<parameter name="year" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="isLocalhost" returns="boolean" >
<help><![CDATA[
Determines whether the specified IP address is the localhost.
]]></help>
<parameter name="ipaddress" required="true" type="String">
<help><![CDATA[
Valid IP address.
]]></help>
</parameter>
</function>
<!--
boolean IsNumeric(string)
-->
<function name="isNumeric" returns="boolean" >
<help><![CDATA[
Determines whether a string can be converted to a numeric value.
Supports numbers in U.S. number format. For other number support
use LSIsNumeric.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsNumericDate(number)
-->
<function name="isNumericDate" returns="boolean" >
<help><![CDATA[
Evaluates whether a real number is a valid representation of a
date (date/time object).
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsObject(value)
-->
<function name="isObject" returns="boolean" >
<help><![CDATA[
Determines whether a value is an object.
True, if the value represents a CFML object. False if
the value is any other type of data, such as an integer, string,
date, or struct.
]]></help>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsPdfFile(path)
-->
<function name="isPDFFile" returns="boolean" >
<help><![CDATA[
Verifies whether a PDF file is valid.
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
Pathname to a PDF file.
]]></help>
</parameter>
</function>
<function name="isPDFObject" returns="boolean" >
<help><![CDATA[
Determines whether a value is a PDF object.
]]></help>
<parameter name="value" required="true" type="Variablename">
<help><![CDATA[
A value, typically the PDF object stored as a variable name.
]]></help>
</parameter>
</function>
<!--
boolean IsQuery(value)
-->
<function name="isQuery" returns="boolean" >
<help><![CDATA[
Determines whether value is a query.
]]></help>
<parameter name="value" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsSimpleValue(value)
-->
<function name="isSimpleValue" returns="boolean" >
<help><![CDATA[
Determines the type of a value.
]]></help>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsSOAPRequest()
-->
<function name="isSOAPRequest" returns="boolean" >
<help><![CDATA[
Determines whether a CFC is being called as a web service.
]]></help>
</function>
<!--
boolean IsStruct(variable)
-->
<function name="isStruct" returns="boolean" >
<help><![CDATA[
Determines whether a variable is a structure.
True, if variable is a CFML structure or is a Java object
that implements the java.lang.Map interface. Returns False if the
object in variable is a user-defined function (UDF).
]]></help>
<parameter name="variable" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsUserInRole("role_name")
-->
<function name="isUserInRole" returns="String" >
<help><![CDATA[
Determines whether an authenticated user belongs to the
specified Role.
]]></help>
<parameter name="role_name" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="isUserLoggedIn" returns="boolean" >
<help><![CDATA[
Determines whether a user is logged in.
]]></help>
</function>
<!--
boolean IsValid(type, value)
boolean IsValid("range", value, min, max)
boolean IsValid("Regex" or "regular_expression", value, pattern)
-->
<function name="isValid" returns="boolean" >
<help><![CDATA[
Tests whether a value meets a validation or data type rule.
]]></help>
<parameter name="type" required="true" type="String">
<help><![CDATA[
The valid format for the data.
]]></help>
<values>
<value option="Any"/>
<value option="Array"/>
<value option="Binary"/>
<value option="boolean"/>
<value option="creditcard"/>
<value option="date"/>
<value option="time"/>
<value option="email"/>
<value option="eurodate"/>
<value option="float"/>
<value option="Numeric"/>
<value option="guid"/>
<value option="integer"/>
<value option="Query"/>
<value option="range"/>
<value option="Regex"/>
<value option="regular_expression"/>
<value option="ssn"/>
<value option="social_security_number"/>
<value option="String"/>
<value option="Struct"/>
<value option="telephone"/>
<value option="URL"/>
<value option="UUID"/>
<value option="usdate"/>
<value option="variablename"/>
<value option="xml"/>
<value option="zipcode"/>
</values>
</parameter>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
The value to test.
]]></help>
</parameter>
<parameter name="min" required="true" type="Numeric">
<help><![CDATA[
The minimum valid value; used only for range validation.
]]></help>
<triggers>
<selectedValue attributeName="type" index="1"
required="true" value="range"/>
</triggers>
</parameter>
<parameter name="max" required="true" type="Numeric">
<help><![CDATA[
The maximum valid value; used only for range validation.
]]></help>
<triggers>
<selectedValue attributeName="type" index="1"
required="true" value="range"/>
</triggers>
</parameter>
<parameter name="pattern" required="true" type="String">
<help><![CDATA[
A regular expression that the parameter must match;
used only for regex or regular_expression validation.
]]></help>
<triggers>
<selectedValue attributeName="type" index="1"
required="true" value="Regex"/>
<selectedValue attributeName="type" index="2"
required="true" value="regular_expression"/>
</triggers>
</parameter>
</function>
<!--
boolean IsWDDX(value)
-->
<function name="isWDDX" returns="boolean" >
<help><![CDATA[
Determines whether a value is a well-formed WDDX packet.
]]></help>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsXML(value)
-->
<function name="isXML" returns="boolean" >
<help><![CDATA[
Determines whether a string is well-formed XML text.
]]></help>
<parameter name="value" required="true" type="String">
<help><![CDATA[
A string containing the XML document text.
]]></help>
</parameter>
</function>
<!--
boolean IsXmlAttribute(value)
-->
<function name="isXMLAttribute" returns="boolean" >
<help><![CDATA[
Determines whether the function parameter is an
XML Document Object Model (DOM) attribute node.
]]></help>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
Name of an XML attribute.
]]></help>
</parameter>
</function>
<!--
boolean IsXmlDoc(value)
-->
<function name="isXMLDoc" returns="boolean" >
<help><![CDATA[
Determines whether a function parameter is an Extended Markup
language (XML) document object.
]]></help>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsXmlElem(value)
-->
<function name="isXMLElem" returns="boolean" >
<help><![CDATA[
Determines whether a function parameter is an Extended Markup
language (XML) document object element.
]]></help>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean IsXmlNode(value)
-->
<function name="isXMLNode" returns="boolean" >
<help><![CDATA[
Determines whether the function parameter is
an XML document object node.
]]></help>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
Name of an XML document object node.
]]></help>
</parameter>
</function>
<!--
boolean IsXmlRoot(value)
-->
<function name="isXMLRoot" returns="boolean" >
<help><![CDATA[
Determines whether a function parameter is the root element of
an Extended Markup language (XML) document object.
]]></help>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Object JavaCast(type, variable)
-->
<function name="javacast" returns="Object" >
<help><![CDATA[
Converts the data type of a CFML variable to pass as an
argument to an overloaded method of a Java object. Use only
for scalar and string arguments.
[type - quicky]
boolean,int,long,float,double,string
]]></help>
<parameter name="type" required="true" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="boolean"/>
<value option="double"/>
<value option="float"/>
<value option="int"/>
<value option="long"/>
<value option="string"/>
</values>
</parameter>
<parameter name="variable" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String JSStringFormat(string)
-->
<function name="jsStringFormat" returns="String" >
<help><![CDATA[
Escapes special JavaScript characters, such as single quotation
mark, double quotation mark, and newline
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String LCase(string)
-->
<function name="lCase" returns="String" >
<help><![CDATA[
Converts the alphabetic characters in a string to lowercase.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String Left(string, count)
-->
<function name="left" returns="String" >
<help><![CDATA[
Returns the leftmost count characters in a string.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="count" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric Len(string or binary object)
-->
<function name="len" returns="Numeric" >
<help><![CDATA[
Determines the length of a string or binary object
]]></help>
<parameter name="Object" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String ListAppend(list, value [, delimiters ])
-->
<function name="listAppend" returns="String" >
<help><![CDATA[
Concatenates a list or element to a list.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
An element or a list of elements.
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option="_"/>
<value option=";"/>
<value option=":"/>
</values>
</parameter>
</function>
<!--
String ListChangeDelims(list, new_delimiter [, delimiters ])
-->
<function name="listChangeDelims" returns="String" >
<help><![CDATA[
Changes a list delimiter.
Returns a copy of the list, with each delimiter character
replaced by new_delimiter.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="new_delimiter" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
Numeric ListContains(list, substring [, delimiters ])
-->
<function name="listContains" returns="Numeric" >
<help><![CDATA[
Determines the index of the first list element that contains a
specified substring.
Returns the index of the first list element that contains
substring. If not found, returns zero.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="substring" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
Numeric ListContainsNoCase(list, substring [, delimiters ])
-->
<function name="listContainsNoCase" returns="Numeric" >
<help><![CDATA[
Determines the index of the first list element that contains a
specified substring.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="substring" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
String ListDeleteAt(list, position [, delimiters ])
-->
<function name="listDeleteAt" returns="String" >
<help><![CDATA[
Deletes an element from a list.
Returns a copy of the list, without the specified element.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="position" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
Numeric ListFind(list, value [, delimiters ])
-->
<function name="listFind" returns="Numeric" >
<help><![CDATA[
Determines the index of the first list element in which a
specified value occurs. Case-sensitive
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
Numeric ListFindNoCase(list, value [, delimiters ])
-->
<function name="listFindNoCase" returns="Numeric" >
<help><![CDATA[
Determines the index of the first list element in which a
specified value occurs
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter default="," name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
String ListFirst(list [, delimiters ])
-->
<function name="listFirst" returns="String" >
<help><![CDATA[
Gets the first element of a list.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
String ListGetAt(list, position [, delimiters ])
-->
<function name="listGetAt" returns="String" >
<help><![CDATA[
Gets a list element at a specified position.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="position" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
String ListInsertAt(list, position, value [, delimiters ])
-->
<function name="listInsertAt" returns="String" >
<help><![CDATA[
Inserts an element in a list.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="position" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
String ListLast(list [, delimiters ])
-->
<function name="listLast" returns="String" >
<help><![CDATA[
Gets the last element of a list.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
Numeric ListLen(list [, delimiters ])
-->
<function name="listLen" returns="Numeric" >
<help><![CDATA[
Determines the number of elements in a list.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
String ListPrepend(list, value [, delimiters ])
-->
<function name="listPrepend" returns="String" >
<help><![CDATA[
Inserts an element at the beginning of a list.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
String ListQualify(list, qualifier [, delimiters ] [, elements ])
-->
<function name="listQualify" returns="String" >
<help><![CDATA[
Inserts a string at the beginning and end of list elements.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="qualifier" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
<parameter name="elements" required="false" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="all"/>
<value option="char"/>
</values>
</parameter>
</function>
<!--
String ListRest(list [, delimiters ])
-->
<function name="listRest" returns="String" >
<help><![CDATA[
Gets a list, without its first element.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
String ListSetAt(list, position, value [, delimiters ])
-->
<function name="listSetAt" returns="String" >
<help><![CDATA[
Replaces the contents of a list element.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="position" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
String ListSort(list, sort_type [, sort_order] [, delimiters ])
-->
<function name="listSort" returns="String" >
<help><![CDATA[
Sorts list elements according to a sort type and sort order.
Returns a sorted copy of the list.
[sort_type - quicky]
numeric: sorts numbers
text: sorts text alphabetically, taking case into account
- aabzABZ, if sort_order = "asc"
- ZBAzbaa, if sort_order = "desc"
textnocase: sorts text alphabetically, without regard to case
- aAaBbBzzZ, in an asc sort;
- ZzzBbBaAa, in a desc sort;
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="sort_type" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="sort_order" required="false" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
Array ListToArray(list [, delimiters ])
-->
<function name="listToArray" returns="Array" >
<help><![CDATA[
Copies the elements of a list to an array.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
<parameter name="includeEmptyFields" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether to create empty array entries if there are two delimiters in a row.
]]></help>
<values >
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="multiCharacterDelimiter" required="false" type="Boolean">
<help><![CDATA[
A Boolean value specifying whether the delimiters parameter specifies a multi-character delimiter.
]]></help>
<values >
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</function>
<!--
Numeric ListValueCount(list, value [, delimiters ])
-->
<function name="listValueCount" returns="Numeric" >
<help><![CDATA[
Counts instances of a specified value in a list. The search is
case-sensitive.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
Numeric ListValueCountNoCase(list, value [, delimiters ])
-->
<function name="listValueCountNoCase" returns="Numeric" >
<help><![CDATA[
Counts instances of a specified value in a list. The search is
case-insensitive.
]]></help>
<parameter name="list" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiters" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
String LJustify(string, length)
-->
<function name="lJustify" returns="String" >
<help><![CDATA[
Left justifies characters in a string of a specified length.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="length" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="location" returns="void" >
<help><![CDATA[
Stops execution of the current page and opens a CFML page or HTML file.
]]></help>
<parameter name="url" required="true" type="String">
<help><![CDATA[
URL of HTML file or CFML page to open.
]]></help>
</parameter>
<parameter name="addtoken" required="false" type="boolean">
<help><![CDATA[
clientManagement must be enabled (see cfapplication).
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="statuscode" required="false" type="Numeric">
<help><![CDATA[
The HTTP status code
]]></help>
</parameter>
</function>
<!--
Numeric Log(number)
-->
<function name="log" returns="Numeric" >
<help><![CDATA[
Calculates the natural logarithm of a number. Natural
logarithms are based on the constant e (2.71828182845904).
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric Log10(number)
-->
<function name="log10" returns="Numeric" >
<help><![CDATA[
Calculates the logarithm of number, to base 10.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String LSCurrencyFormat(number [, type ])
-->
<function name="lsCurrencyFormat" returns="String" >
<help><![CDATA[
Formats a number in a locale-specific currency format. For
countries that use the euro, the result depends on the JVM.
[type - quicky]
local: the currency format and currency symbol used locally.
- With JDK 1.3, the default for Euro Zone: local currency.
- With JDK 1.4, the default for Euro Zone: euro.
international: the international standard currency format
none: the local currency format; no currency symbol
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="local"/>
<value option="international"/>
<value option="none"/>
</values>
</parameter>
</function>
<!--
String LSDateFormat(date [, mask ])
-->
<function name="lsDateFormat" returns="String" >
<help><![CDATA[
Formats the date part of a date/time value in a locale-specific
format.
[mask - quicky]
d,dd,ddd,dddd: Day of month / week
m,mm,mmm,mmmm: Month; y,yy,yyyy: Year; gg: Period/era string
short / medium / long / full
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
<parameter name="mask" required="false" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="short"/>
<value option="medium"/>
<value option="long"/>
<value option="full"/>
</values>
</parameter>
</function>
<!--
String LSEuroCurrencyFormat(currency-number [, type ])
-->
<function name="lsEuroCurrencyFormat" returns="String" >
<help><![CDATA[
Formats a number in a locale-specific currency format.
[type - quicky]
local: the currency format used in the locale. (Default.)
international: the international standard currency format
none: the currency format used; no currency symbol
]]></help>
<parameter name="currency" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="type" required="true" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="local"/>
<value option="international"/>
<value option="none"/>
</values>
</parameter>
</function>
<!--
boolean LSIsCurrency(string)
-->
<function name="lsIsCurrency" returns="boolean" >
<help><![CDATA[
Determines whether a string is a valid representation of a
currency amount in the current locale.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean LSIsDate(string)
-->
<function name="lsIsDate" returns="boolean" >
<help><![CDATA[
Determines whether a string is a valid representation of a
date/time value in the current locale.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean LSIsNumeric(string)
-->
<function name="lsIsNumeric" returns="boolean" >
<help><![CDATA[
Determines whether a string is a valid representation of a
number in the current locale.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="isNull" returns="boolean" >
<help><![CDATA[
Determines whether given object is null or not
]]></help>
<parameter name="object" required="true" type="variablename">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String LSNumberFormat(number [, mask ])
-->
<function name="lsNumberFormat" returns="String" >
<help><![CDATA[
Formats a number in a locale-specific format.
[mask - quicky]
_,9 Digit placeholder; . decimal point; 0 Pads with zeros;
( ) less than zero, puts parentheses around the mask
+ plus sign before positive number minus before negative
- a space before positive minus sign before negative
, Separates every third decimal place with a comma.
L,C Left-justifies or center-justifies number
$ dollar sign before formatted number.
^ Separates left and right formatting.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="mask" required="false" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String LSParseCurrency(string)
-->
<function name="lsParseCurrency" returns="String" >
<help><![CDATA[
Converts a locale-specific currency string into a formatted
number. Attempts conversion by comparing the string with each
the three supported currency formats (none, local,
international) and using the first that matches.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
DateTime LSParseDateTime(date/time-string)
-->
<function name="lsParseDateTime" returns="DateTime" >
<help><![CDATA[
Converts a string that is a valid date/time representation in
the current locale into a date/time object.
]]></help>
<parameter name="dt_string" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric LSParseEuroCurrency(currency-string)
-->
<function name="lsParseEuroCurrency" returns="Numeric" >
<help><![CDATA[
Formats a locale-specific currency string as a number.
Attempts conversion through each of the default currency
formats (none, local, international). Ensures correct
handling of euro currency for Euro zone countries.
]]></help>
<parameter name="currency_string" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric LSParseNumber(string)
-->
<function name="lsParseNumber" returns="Numeric" >
<help><![CDATA[
Converts a string that is a valid numeric representation in
the current locale into a formatted number.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String LSTimeFormat(time [, mask ])
-->
<function name="lsTimeFormat" returns="String" >
<help><![CDATA[
Formats the time part of a date/time string into a string in a
locale-specific format.
[mask - quicky]
h,hh,H,HH: Hours; m,mm: Minutes; s,ss: Seconds;
l: Milliseconds; t: A or P; tt: AM or PM
"short" = h:mm tt; "medium" = h:mm:ss tt
]]></help>
<parameter name="time" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
<parameter name="mask" required="false" type="String">
<help><![CDATA[
]]></help>
<values>
<value option="short"/>
<value option="medium"/>
<value option="long"/>
</values>
</parameter>
</function>
<!--
String LTrim(string)
-->
<function name="lTrim" returns="String" >
<help><![CDATA[
Removes leading spaces from a string.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric Max(number1, number2)
-->
<function name="max" returns="Numeric" >
<help><![CDATA[
Determines the greater of two numbers.
]]></help>
<parameter name="number1" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="number2" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String Mid(string, start, count)
-->
<function name="mid" returns="String" >
<help><![CDATA[
Extracts a substring from a string.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
The string from which the substring will be extracted.
]]></help>
</parameter>
<parameter name="start" required="true" type="Numeric">
<help><![CDATA[
The position of the first character to retrieve.
]]></help>
</parameter>
<parameter name="count" required="true" type="Numeric">
<help><![CDATA[
The number of characters to retrieve.
]]></help>
</parameter>
</function>
<!--
Numeric Min(number1, number2)
-->
<function name="min" returns="Numeric" >
<help><![CDATA[
Determines the lesser of two numbers.
]]></help>
<parameter name="number1" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="number2" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric Minute(date)
-->
<function name="minute" returns="Numeric" >
<help><![CDATA[
Extracts the minute value from a date/time object.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
Numeric Month(date)
-->
<function name="month" returns="Numeric" >
<help><![CDATA[
Extracts the month value from a date/time object.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
String MonthAsString(month_number)
-->
<function name="monthAsString" returns="String" >
<help><![CDATA[
]]></help>
<parameter name="month_number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
DateTime Now()
-->
<function name="now" returns="DateTime" >
<help><![CDATA[
Gets the current date and time of the computer running the
CFML server.
]]></help>
</function>
<!--
String NumberFormat(number [, mask ])
-->
<function name="numberFormat" returns="String" >
<help><![CDATA[
Creates a custom-formatted number value. For international
number formatting use LSNumberFormat.
[mask - quicky]
_,9 Digit placeholder; . decimal point; 0 Pads with zeros;
( ) less than zero, puts parentheses around the mask
+ plus sign before positive number minus before negative
- a space before positive minus sign before negative
, Separates every third decimal place with a comma.
L,C Left-justifies or center-justifies number
$ dollar sign before formatted number.
^ Separates left and right formatting.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="mask" required="false" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String ParagraphFormat(string)
-->
<function name="paragraphFormat" returns="String" >
<help><![CDATA[
Replaces characters in a string:
* Single newline characters (CR/LF sequences) with spaces
* Double newline characters with HTML paragraph tags (<p>)
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
DateTime ParseDateTime(date/time-string [, pop-conversion ] )
-->
<function name="parseDateTime" returns="DateTime" >
<help><![CDATA[
Parses a date/time string according to the English (U.S.)
locale conventions. (To format a date/time string for other
locales, use the LSParseDateTime function.)
]]></help>
<parameter name="dt_string" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="pop_conversion" required="false" type="String">
<help><![CDATA[
- standard: (the default) function does no conversion.
- pop: specifies that the date/time string is in POP format,
which includes the local time of the sender and a time-zone
offset from UTC. ColdFusion applies the offset and returns
a value with the UTC time.
]]></help>
<values default="standard">
<value option="standard"/>
<value option="pop"/>
</values>
</parameter>
</function>
<!--
Numeric Pi()
-->
<function name="pi" returns="Numeric" >
<help><![CDATA[
Gets the mathematical constant p, accurate to 15 digits.
The number 3.14159265358979.
]]></help>
</function>
<function name="precisionEvaluate" returns="Numeric" >
<help><![CDATA[
Evaluates one or more string expressions.
]]></help>
<parameter name="expressions" required="true" type="String">
<help><![CDATA[
Expressions to evaluate
]]></help>
</parameter>
</function>
<!--
void PreserveSingleQuotes(variable)
-->
<function name="preserveSingleQuotes" returns="void" >
<help><![CDATA[
Prevents CFML from automatically escaping single
quotation mark characters that are contained in a variable.
CFML does not evaluate the argument.
Note: ColdFusion automatically escapes simple-variable,
array-variable, and structure-variable references within a
cfquery tag body or block.
]]></help>
<parameter name="variable" required="true" type="String">
<help><![CDATA[
Variable that contains a string in which to preserve
single quotation marks.
]]></help>
</parameter>
</function>
<!--
Numeric Quarter(date)
-->
<function name="quarter" returns="Numeric" >
<help><![CDATA[
Calculates the quarter of the year in which a date falls.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
Numeric QueryAddColumn(query, column-name[, datatype], array-name)
-->
<function name="queryAddColumn" returns="Numeric" >
<help><![CDATA[
Adds a column to a query and populates its rows with the
contents of a one-dimensional array. Pads query columns,
if necessary, to ensure that all columns have the same number
of rows.
]]></help>
<parameter name="query" required="true" type="Query">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="column_name" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="datatype" required="false" type="String">
<help><![CDATA[
Column data type.
]]></help>
<values>
<value option="Integer"/>
<value option="BigInt"/>
<value option="Double"/>
<value option="Decimal"/>
<value option="VarChar"/>
<value option="Binary"/>
<value option="Bit"/>
<value option="Time"/>
<value option="Data"/>
</values>
</parameter>
<parameter name="array_name" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric QueryAddRow(query [, number ])
-->
<function name="queryAddRow" returns="Numeric" >
<help><![CDATA[
Adds a specified number of empty rows to a query.
]]></help>
<parameter name="query" required="true" type="Query">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="number" required="false" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Query QueryNew(columnlist [, columntypelist])
-->
<function name="queryNew" returns="Query" >
<help><![CDATA[
Creates an empty query (query object).
]]></help>
<parameter name="columnlist" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one. Delimited list
of column names, or an empty string.
]]></help>
</parameter>
<parameter name="columntypelist" required="false" type="String">
<help><![CDATA[
Comma-delimited list specifying column data types.
]]></help>
<values>
<value option="Integer"/>
<value option="BigInt"/>
<value option="Double"/>
<value option="Decimal"/>
<value option="VarChar"/>
<value option="Binary"/>
<value option="Bit"/>
<value option="Time"/>
<value option="Data"/>
</values>
</parameter>
</function>
<!--
boolean QuerySetCell(query, column_name, value [, row_number ])
-->
<function name="querySetCell" returns="boolean" >
<help><![CDATA[
Sets a cell to a value. If no row number is specified,
the cell on the last row is set.
]]></help>
<parameter name="query" required="true" type="Query">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="column" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="row" required="false" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String QuotedValueList(query.column [, delimiter ])
-->
<function name="quotedValueList" returns="String" >
<help><![CDATA[
Gets the values of each record returned from an executed query.
CFML does not evaluate the arguments
]]></help>
<parameter name="column" required="true" type="QueryColumn">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="delimiter" required="false" type="String">
<help><![CDATA[
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
Numeric Rand([algorithm])
-->
<function name="rand" returns="Numeric" >
<help><![CDATA[
Generates a pseudo-random number in the range 0 - 1.
]]></help>
<parameter name="algorithm" required="false" type="String">
<help><![CDATA[
The algorithm to use to generated the random number.
]]></help>
<values default="CFMX_COMPAT">
<value option="CFMX_COMPAT"/>
<value option="SHA1PRNG"/>
<value option="IBMSecureRandom"/>
</values>
</parameter>
</function>
<!--
Numeric Randomize(number[, algorithm])
-->
<function name="randomize" returns="Numeric" >
<help><![CDATA[
Seeds the pseudo-random number generator with an
integer number, ensuring repeatable number patterns.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="algorithm" required="false" type="String">
<help><![CDATA[
The algorithm to use to generated the random number.
]]></help>
<values default="CFMX_COMPAT">
<value option="CFMX_COMPAT"/>
<value option="SHA1PRNG"/>
<value option="IBMSecureRandom"/>
</values>
</parameter>
</function>
<!--
Numeric RandRange(number1, number2[, algorithm])
-->
<function name="randRange" returns="Numeric" >
<help><![CDATA[
Generates a random integer between two specified numbers.
Requests for random integers that are greater than 100,000,000
result in non-random numbers, to prevent overflow during
internal computations.
]]></help>
<parameter name="number1" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="number2" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="algorithm" required="false" type="String">
<help><![CDATA[
The algorithm to use to generated the random number.
]]></help>
<values default="CFMX_COMPAT">
<value option="CFMX_COMPAT"/>
<value option="SHA1PRNG"/>
<value option="IBMSecureRandom"/>
</values>
</parameter>
</function>
<!--
Object REFind(reg_expression, string [, start ][, returnsubexpressions ])
-->
<function name="reFind" returns="Object" >
<help><![CDATA[
]]></help>
<parameter name="reg_expression" required="true" type="Regex">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one. String in which
to search.
]]></help>
</parameter>
<parameter name="start" required="false" type="Numeric">
<help><![CDATA[
]]></help>
<values default="1">
<value option="1"/>
</values>
</parameter>
<parameter name="returnsubexpressions" required="false" type="boolean">
<help><![CDATA[
True: if the regular expression is found, the first array
element contains the length and position, respectively,
of the first match.
If the regular expression contains parentheses that
group subexpressions, each subsequent array element
contains the length and position, respectively, of
the first occurrence of each group.
If the regular expression is not found, the arrays each
contain one element with the value 0.
False: the function returns the position in the string
where the match begins. Default.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</function>
<!--
Object REFindNoCase(reg_expression, string [, start] [, returnsubexpressions] )
-->
<function name="refindNoCase" returns="Object" >
<help><![CDATA[
Uses a regular expression (RE) to search a string for a pattern,
starting from a specified position. The search is
case-insensitive.
]]></help>
<parameter name="reg_expression" required="true" type="Regex">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one. String in which
to search.
]]></help>
<values default="1">
<value option="1"/>
</values>
</parameter>
<parameter name="start" required="false" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="returnsubexpressions" required="false" type="boolean">
<help><![CDATA[
True: if the regular expression is found, the first array
element contains the length and position, respectively,
of the first match.
If the regular expression contains parentheses that
group subexpressions, each subsequent array element
contains the length and position, respectively, of
the first occurrence of each group.
If the regular expression is not found, the arrays each
contain one element with the value 0.
False: the function returns the position in the string
where the match begins. Default.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</function>
<function name="rematch" returns="Array" >
<help><![CDATA[
Uses a regular expression (RE) to search a string for a pattern, starting from a specified position.
]]></help>
<parameter name="reg_expression" required="true" type="String">
<help><![CDATA[
Regular expression for which to search. Case sensitive.
]]></help>
</parameter>
<parameter name="string" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one. String in which to search.
]]></help>
</parameter>
</function>
<function name="reMatchNoCase" returns="Array" >
<help><![CDATA[
Uses a regular expression (RE) to search a string for a pattern, starting from a specified position.
]]></help>
<parameter name="reg_expression" required="true" type="String">
<help><![CDATA[
Regular expression for which to search. Case insensitive.
]]></help>
</parameter>
<parameter name="string" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one. String in which to search.
]]></help>
</parameter>
</function>
<!--
void ReleaseComObject(objectName)
-->
<function name="releaseCOMObject" returns="void" >
<help><![CDATA[
Releases a COM Object and frees up resources that it used.
]]></help>
<parameter name="objectName" required="true" type="Object">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String RemoveChars(string, start, count)
-->
<function name="removeChars" returns="String" >
<help><![CDATA[
Removes characters from a string.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="start" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="count" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String RepeatString(string, count)
-->
<function name="repeatString" returns="String" >
<help><![CDATA[
Creates a string that contains a specified number of
repetitions of the specified string.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="count" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String Replace(string, substring1, substring2 [, scope ])
-->
<function name="replace" returns="String" >
<help><![CDATA[
Replaces occurrences of substring1 in a string with substring2,
in a specified scope. The search is case-sensitive.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="substring1" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="substring2" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="scope" required="false" type="String">
<help><![CDATA[
* one: replace the first occurrence (default)
* all: replace all occurrences
]]></help>
<values>
<value option="one"/>
<value option="all"/>
</values>
</parameter>
</function>
<!--
String ReplaceList(string, list1, list2)
-->
<function name="replaceList" returns="String" >
<help><![CDATA[
Replaces occurrences of the elements from a delimited list
in a string with corresponding elements from another delimited
list. The search is case-sensitive.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="list1" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="list2" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String ReplaceNoCase(string, substring1, substring2 [, scope ])
-->
<function name="replaceNoCase" returns="String" >
<help><![CDATA[
Replaces occurrences of substring1 with substring2, in the
specified scope. The search is case-insensitive.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string (or variable that contains one) within which to
replace substring
]]></help>
</parameter>
<parameter name="substring1" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="substring2" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="scope" required="false" type="String">
<help><![CDATA[
* one: Replace the first occurrence (default)
* all: Replace all occurrences
]]></help>
<values>
<value option="one"/>
<value option="all"/>
</values>
</parameter>
</function>
<!--
String REReplace(string, reg_expression, substring [, scope ])
-->
<function name="rereplace" returns="String" >
<help><![CDATA[
Uses a regular expression (RE) to search a string for a string
pattern and replace it with another. The search is
case-sensitive.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one
]]></help>
</parameter>
<parameter name="reg_expression" required="true" type="Regex">
<help><![CDATA[
Regular expression to replace.
]]></help>
</parameter>
<parameter name="substring" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one. Replaces
reg_expression
]]></help>
</parameter>
<parameter name="scope" required="false" type="String">
<help><![CDATA[
* one: Replace the first occurrence of the regular
expression. Default.
* all: Replace all occurrences of the regular expression.
]]></help>
<values>
<value option="one"/>
<value option="all"/>
</values>
</parameter>
</function>
<!--
String REReplaceNoCase(string, reg_expression, substring [, scope ])
-->
<function name="rereplaceNoCase" returns="String" >
<help><![CDATA[
Uses a regular expression to search a string for a string
pattern and replace it with another. The search is
case-insensitive.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one
]]></help>
</parameter>
<parameter name="reg_expression" required="true" type="Regex">
<help><![CDATA[
Regular expression to replace.
]]></help>
</parameter>
<parameter name="substring" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one. Replaces
reg_expression
]]></help>
</parameter>
<parameter name="scope" required="false" type="String">
<help><![CDATA[
* one: Replace the first occurrence of the regular
expression. Default.
* all: Replace all occurrences of the regular expression.
]]></help>
<values>
<value option="one"/>
<value option="all"/>
</values>
</parameter>
</function>
<!--
String Reverse(string)
-->
<function name="reverse" returns="String" >
<help><![CDATA[
Reverses the order of items, such as the characters in a
string, the digits in a number, or the elements in an array.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one
]]></help>
</parameter>
</function>
<!--
String Right(string, count)
-->
<function name="right" returns="String" >
<help><![CDATA[
Gets a specified number of characters from a string,
beginning at the right.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="count" required="true" type="Numeric">
<help><![CDATA[
A positive integer or a variable that contains one.
Number of characters to return.
]]></help>
</parameter>
</function>
<!--
String RJustify(string, length)
-->
<function name="rJustify" returns="String" >
<help><![CDATA[
Right justifies characters of a string.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="length" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric Round(number)
-->
<function name="round" returns="Numeric" >
<help><![CDATA[
Rounds a number to the closest integer.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String RTrim(string)
-->
<function name="rTrim" returns="String" >
<help><![CDATA[
Removes spaces from the end of a string.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one
]]></help>
</parameter>
</function>
<!--
Numeric Second(date)
-->
<function name="second" returns="Numeric" >
<help><![CDATA[
Extracts the ordinal for the second from a date/time object.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
A date/time object
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
String SendGatewayMessage(gatewayID, data)
-->
<function name="sendGatewayMessage" returns="String" >
<help><![CDATA[
Sends an outgoing message through a ColdFusion MX event gateway.
]]></help>
<parameter name="gatewayID" required="true" type="String">
<help><![CDATA[
Identifier of the gateway to send the message.
]]></help>
</parameter>
<parameter name="data" required="true" type="Struct">
<help><![CDATA[
A ColdFusion structure.
]]></help>
</parameter>
</function>
<function name="serializeJSON" returns="String" >
<help><![CDATA[
Converts ColdFusion data into a JSON (JavaScript Object Notation) representation of the data.
]]></help>
<parameter name="var" required="true" type="Variablename">
<help><![CDATA[
A ColdFusion data value or variable that represents one.
]]></help>
</parameter>
<parameter name="serializeQueryByColumns" required="false" type="boolean">
<help><![CDATA[
A Boolean value that specifies how to serialize ColdFusion queries.
]]></help>
</parameter>
</function>
<!--
void SetEncoding(scope_name,charset)
-->
<function name="setEncoding" returns="void" >
<help><![CDATA[
Sets the character encoding (character set) of Form and URL
scope variable values; used when the character encoding of
the input to a form, or the character encoding of a URL, is
not in UTF-8 encoding.
]]></help>
<parameter name="scope_name" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="charset" required="true" type="String">
<help><![CDATA[
The character encoding in which text in the scope
variables is encoded.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
</parameter>
</function>
<!--
String SetLocale(new_locale)
-->
<function name="setLocale" returns="String" >
<help><![CDATA[
Sets the country/language locale for CFML processing
and the page returned to the client. The locale value
determines the default format of date, time, number, and
currency values, according to language and regional
conventions.
]]></help>
<parameter name="new_locale" required="true" type="String">
<help><![CDATA[
The name of a locale; for example, "English (US)"
]]></help>
<values>
<value option="Chinese (China)"/>
<value option="Chinese (Hong Kong)"/>
<value option="Chinese (Taiwan)"/>
<value option="Dutch (Belgian)"/>
<value option="Dutch (Standard)"/>
<value option="English (Australian)"/>
<value option="English (Canadian)"/>
<value option="English (New Zealand)"/>
<value option="English (US)"/>
<value option="English (UK)"/>
<value option="French (Belgian)"/>
<value option="French (Canadian)"/>
<value option="French (Standard)"/>
<value option="French (Swiss)"/>
<value option="German (Austrian)"/>
<value option="German (Standard)"/>
<value option="German (Swiss)"/>
<value option="Italian (Standard)"/>
<value option="Italian (Swiss)"/>
<value option="Japanese"/>
<value option="Korean"/>
<value option="Norwegian (Bokmal)"/>
<value option="Norwegian (Nynorsk)"/>
<value option="Portuguese (Brazilian)"/>
<value option="Portuguese (Standard)"/>
<value option="Spanish (Modern)"/>
<value option="Spanish (Standard)"/>
<value option="Swedish"/>
</values>
</parameter>
</function>
<!--
String SetProfileString(iniPath, section, entry, value)
-->
<function name="setProfileString" returns="String" >
<help><![CDATA[
Sets the value of a profile entry in an initialization file.
]]></help>
<parameter name="inipath" required="true" type="String">
<help><![CDATA[
Absolute path of initialization file
]]></help>
</parameter>
<parameter name="section" required="true" type="String">
<help><![CDATA[
Section of the initialization file in which the entry is
to be set
]]></help>
</parameter>
<parameter name="entry" required="true" type="String">
<help><![CDATA[
Name of the entry to set
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
Value to which to set the entry
]]></help>
</parameter>
</function>
<!--
void SetVariable(name, value)
-->
<function name="setVariable" returns="void" >
<help><![CDATA[
This function is no longer required in well-formed CFML
pages. Sets a variable in the name parameter to the value of the
value parameter.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
Variable name
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
A string, the name of a string, or a number
]]></help>
</parameter>
</function>
<!--
Numeric Sgn(number)
-->
<function name="sgn" returns="Numeric" >
<help><![CDATA[
Determines the sign of a number.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
Numeric Sin(number)
-->
<function name="sin" returns="Numeric" >
<help><![CDATA[
Calculates the sine of an angle that is entered in radians.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String SpanExcluding(string, set)
-->
<function name="spanExcluding" returns="String" >
<help><![CDATA[
Gets characters from a string, from the beginning to a
character that is in a specified set of characters. The
search is case-sensitive.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="set" required="true" type="String">
<help><![CDATA[
A string or a variable that contains a set of characters.
Must contain one or more characters
]]></help>
</parameter>
</function>
<!--
String SpanIncluding(string, set)
-->
<function name="spanIncluding" returns="String" >
<help><![CDATA[
Gets characters from a string, from the beginning to a
character that is not in a specified set of characters. The
search is case-sensitive.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="set" required="true" type="String">
<help><![CDATA[
A string or a variable that contains a set of characters.
Must contain one or more characters
]]></help>
</parameter>
</function>
<!--
Numeric Sqr(number)
-->
<function name="sqr" returns="Numeric" >
<help><![CDATA[
Calculates the square root of a number.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
A positive integer or a variable that contains one.
Number whose square root to get.
]]></help>
</parameter>
</function>
<!--
String StripCR(string)
-->
<function name="stripCR" returns="String" >
<help><![CDATA[
Deletes return characters from a string.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one
]]></help>
</parameter>
</function>
<!--
boolean StructAppend(struct1, struct2, overwriteFlag)
-->
<function name="structAppend" returns="boolean" >
<help><![CDATA[
Appends one structure to another.
CFML MX: Changed behavior: this function can be used on
XML objects.
]]></help>
<parameter name="struct1" required="true" type="Struct">
<help><![CDATA[
Structure to append.
]]></help>
</parameter>
<parameter name="struct2" required="true" type="Struct">
<help><![CDATA[
Structure that contains the data to append to struct1
]]></help>
</parameter>
<parameter name="overwriteFlag" required="false" type="boolean">
<help><![CDATA[
Yes: values in struct2 overwrite corresponding values in
struct1. Default.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</function>
<!--
boolean StructClear(structure)
-->
<function name="structClear" returns="boolean" >
<help><![CDATA[
Removes all data from a structure.
]]></help>
<parameter name="structure" required="true" type="Struct">
<help><![CDATA[
Structure to clear
]]></help>
</parameter>
</function>
<!--
Struct StructCopy(structure)
-->
<function name="structCopy" returns="Struct" >
<help><![CDATA[
Copies a structure. Copies top-level keys, values, and arrays
in the structure by value; copies nested structures by
reference.
]]></help>
<parameter name="structure" required="true" type="Struct">
<help><![CDATA[
Structure to copy
]]></help>
</parameter>
</function>
<!--
Numeric StructCount(structure)
-->
<function name="structCount" returns="Numeric" >
<help><![CDATA[
Counts the keys in a structure.
]]></help>
<parameter name="structure" required="true" type="Struct">
<help><![CDATA[
Structure to access
]]></help>
</parameter>
</function>
<!--
boolean StructDelete(structure, key [, indicatenotexisting ])
-->
<function name="structDelete" returns="boolean" >
<help><![CDATA[
Removes an element from a structure.
]]></help>
<parameter name="structure" required="true" type="String">
<help><![CDATA[
Structure or a variable that contains one. Contains element
to remove
]]></help>
</parameter>
<parameter name="key" required="true" type="String">
<help><![CDATA[
Element to remove
]]></help>
</parameter>
<parameter name="indicatenotexisting" required="false" type="boolean">
<help><![CDATA[
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</function>
<!--
Object StructFind(structure, key)
-->
<function name="structFind" returns="Object" >
<help><![CDATA[
Determines the value associated with a key in a structure.
]]></help>
<parameter name="structure" required="true" type="Struct">
<help><![CDATA[
Structure that contains the value to return
]]></help>
</parameter>
<parameter name="key" required="true" type="String">
<help><![CDATA[
Key whose value to return
]]></help>
</parameter>
</function>
<!--
Array StructFindKey(top, value, scope)
-->
<function name="structFindKey" returns="Array" >
<help><![CDATA[
Searches recursively through a substructure of nested arrays,
structures, and other elements, for structures whose values
match the search key in the value parameter.
]]></help>
<parameter name="top" required="true" type="Object">
<help><![CDATA[
CFML object (structure or array) from which to start
search. This attribute requires an object, not a name of
an object.
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
String or a variable that contains one for which to search.
]]></help>
</parameter>
<parameter name="scope" required="true" type="String">
<help><![CDATA[
* one: returns one matching key. Default.
* all: returns all matching keys
]]></help>
<values>
<value option="one"/>
<value option="all"/>
</values>
</parameter>
</function>
<!--
Array StructFindValue( top, value [, scope])
-->
<function name="structFindValue" returns="Array" >
<help><![CDATA[
Searches recursively through a substructure of nested arrays,
structures, and other elements for structures with values that
match the search key in the value parameter.
]]></help>
<parameter name="top" required="true" type="Object">
<help><![CDATA[
CFML object (a structure or an array) from which to
start search. This attribute requires an object, not a
name of an object.
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
String or a variable that contains one for which to search.
The type must be a simple object. Arrays and structures
are not supported.
]]></help>
</parameter>
<parameter name="scope" required="false" type="String">
<help><![CDATA[
one: function returns one matching key (default)
all: function returns all matching keys
]]></help>
<values>
<value option="one"/>
<value option="all"/>
</values>
</parameter>
</function>
<!--
Struct StructGet(pathDesired)
-->
<function name="structGet" returns="Struct" >
<help><![CDATA[
Gets a structure(s) from a specified path.
]]></help>
<parameter name="pathdesired" required="true" type="String">
<help><![CDATA[
Pathname of variable that contains structure or array from
which CFML retrieves structure
]]></help>
</parameter>
</function>
<!--
boolean StructInsert(structure, key, value [, allowoverwrite ])
-->
<function name="structInsert" returns="boolean" >
<help><![CDATA[
Inserts a key-value pair into a structure.
]]></help>
<parameter name="structure" required="true" type="Struct">
<help><![CDATA[
Structure to contain the new key-value pair.
]]></help>
</parameter>
<parameter name="key" required="true" type="String">
<help><![CDATA[
Key that contains the inserted value.
]]></help>
</parameter>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
Value to add.
]]></help>
</parameter>
<parameter name="allowoverwrite" required="false" type="boolean">
<help><![CDATA[
Whether to allow overwriting a key. Default: False.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</function>
<!--
boolean StructIsEmpty(structure)
-->
<function name="structIsEmpty" returns="boolean" >
<help><![CDATA[
Determines whether a structure contains data.
]]></help>
<parameter name="structure" required="true" type="Struct">
<help><![CDATA[
Structure to test
]]></help>
</parameter>
</function>
<!--
Array StructKeyArray(structure)
-->
<function name="structKeyArray" returns="Array" >
<help><![CDATA[
Finds the keys in a CFML structure.
An array of keys; if structure does not exist, CFML
throws an exception.
]]></help>
<parameter name="structure" required="true" type="Struct">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
boolean StructKeyExists(structure, "key")
-->
<function name="structKeyExists" returns="boolean" >
<help><![CDATA[
Determines whether a specific key is present in a structure.
]]></help>
<parameter name="structure" required="true" type="Struct">
<help><![CDATA[
Name of structure to test
]]></help>
</parameter>
<parameter name="key" required="true" type="String">
<help><![CDATA[
Key to test
]]></help>
</parameter>
</function>
<!--
String StructKeyList(structure [, delimiter])
-->
<function name="structKeyList" returns="String" >
<help><![CDATA[
Extracts keys from a CFML structure.
]]></help>
<parameter name="structure" required="true" type="Struct">
<help><![CDATA[
Structure from which to extract a list of keys
]]></help>
</parameter>
<parameter name="delimiter" required="false" type="String">
<help><![CDATA[
Character that separates keys in list. Default: comma.
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
Struct StructNew()
-->
<function name="structNew" returns="Struct" >
<help><![CDATA[
Creates a structure.
]]></help>
</function>
<!--
Array StructSort(base, sortType, sortOrder, pathToSubElement)
-->
<function name="structSort" returns="Array" >
<help><![CDATA[
Returns a sorted array of the top level keys in a structure.
Sorts using alphabetic or numeric sorting, and can sort based
on the values of any structure element.
]]></help>
<parameter name="base" required="true" type="Struct">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="sorttype" required="true" type="String">
<help><![CDATA[
* numeric
* text: case sensitive Default.
* textnocase
]]></help>
<values>
<value option="numeric"/>
<value option="text"/>
<value option="textnocase"/>
</values>
</parameter>
<parameter name="sortorder" required="true" type="String">
<help><![CDATA[
* asc: ascending (a to z) sort order. Default.
* desc: descending (z to a) sort order
]]></help>
</parameter>
<parameter name="pathtosubelement" required="true" type="String">
<help><![CDATA[
String or a variable that contains one
]]></help>
</parameter>
</function>
<!--
boolean StructUpdate(structure, key, value)
-->
<function name="structUpdate" returns="boolean" >
<help><![CDATA[
Updates a key with a value.
]]></help>
<parameter name="structure" required="true" type="Struct">
<help><![CDATA[
Structure to update
]]></help>
</parameter>
<parameter name="key" required="true" type="String">
<help><![CDATA[
Key, the value of which to update
]]></help>
</parameter>
<parameter name="value" required="true" type="Object">
<help><![CDATA[
New value
]]></help>
</parameter>
</function>
<!--
Numeric Tan(number)
-->
<function name="tan" returns="Numeric" >
<help><![CDATA[
Calculates the tangent of an angle that is entered in radians.
]]></help>
<parameter name="number" required="true" type="Numeric">
<help><![CDATA[
Angle, in radians, for which to calculate the tangent
]]></help>
</parameter>
</function>
<function name="throw" returns="Numeric" >
<help><![CDATA[
Throws a developer-specified exception, which can be caught
with a cfcatch tag that has any of the following type attribute
options:
type = "custom_type"
type = "Application"
type = "Any"
]]></help>
<parameter name="type" required="false" type="String">
<help><![CDATA[
* A custom type
* Application
Do not enter another predefined type; types are not
generated by CFML applications. If you specify
Application, you need not specify a type for cfcatch.
]]></help>
<values default="Custom">
<value option="Custom"/>
<value option="Application"/>
<value option="Database"/>
<value option="Template"/>
<value option="Security"/>
<value option="Object"/>
<value option="MissingInclude"/>
<value option="Expression"/>
<value option="Lock"/>
<value option="SearchEngine"/>
</values>
</parameter>
<parameter name="message" required="false" type="String">
<help><![CDATA[
Message that describes exception event.
]]></help>
<values/>
</parameter>
<parameter name="detail" required="false" type="String">
<help><![CDATA[
Description of the event. CFML appends error position
to description; server uses this parameter if an error is
not caught by your code.
]]></help>
<values/>
</parameter>
<parameter name="errorcode" required="false" type="String">
<help><![CDATA[
A custom error code that you supply.
]]></help>
<values/>
</parameter>
<parameter name="extendedinfo" required="false" type="String">
<help><![CDATA[
A custom error code that you supply.
]]></help>
<values/>
</parameter>
<parameter name="object" required="false" type="Object">
<help><![CDATA[
Requires the value of the cfobject tag name attribute.
Throws a Java exception from a CFML tag.
This attribute is mutually exclusive with all other
attributes of this tag.
]]></help>
<values/>
</parameter>
</function>
<!--
String TimeFormat(time [, mask ])
-->
<function name="timeFormat" returns="String" >
<help><![CDATA[
Formats a time value using US English time formatting
conventions. If no mask is specified, returns a time value
using the hh:mm tt format. For international time formatting,
see LSTimeFormat.
[mask]
h,hh,H,HH: Hours; m,mm: Minutes; s,ss: Seconds;
l: Milliseconds; t: A or P; tt: AM or PM
"short" = h:mm tt; "medium" = h:mm:ss tt
]]></help>
<parameter name="time" required="true" type="DateTime">
<help><![CDATA[
A date/time value or string to convert
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
<parameter name="mask" required="false" type="String">
<help><![CDATA[
Masking characters that determine the format
]]></help>
<values>
<value option="short"/>
<value option="medium"/>
<value option="long"/>
<value option="full"/>
</values>
</parameter>
</function>
<!--
String ToBase64(string_or_object[, encoding])
-->
<function name="toBase64" returns="String" >
<help><![CDATA[
Calculates the Base64 representation of a string or binary
object. The Base64 format uses printable characters, allowing
binary data to be sent in forms and e-mail, and stored in a
database or file.
]]></help>
<parameter name="string_or_object" required="true" type="Object">
<help><![CDATA[
A string, the name of a string, or a binary object.
]]></help>
</parameter>
<parameter name="encoding" required="false" type="String">
<help><![CDATA[
For a string, defines how characters are represented in a
byte array.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
</parameter>
</function>
<!--
Binary ToBinary(string_in_Base64 or binary_value)
-->
<function name="toBinary" returns="Binary" >
<help><![CDATA[
Calculates the binary representation of Base64-encoded data.
]]></help>
<parameter name="base64_or_object" required="true" type="Object">
<help><![CDATA[
A string or a variable that contains one:
* In Base64 format to convert to binary
* In binary format to test whether it is valid
]]></help>
</parameter>
</function>
<!--
String ToScript(cfvar, javascriptvar[, outputformat[, asformat]])
-->
<function name="toScript" returns="String" >
<help><![CDATA[
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.
]]></help>
<parameter name="cfvar" required="true" type="Object">
<help><![CDATA[
A ColdFusion variable. This can contain one of the following:
String, Number, Array, Structure or Query.
]]></help>
</parameter>
<parameter name="javascriptvar" required="true" type="String">
<help><![CDATA[
A string that specifies the name of the JavaScript variable
that the ToScript function creates.
]]></help>
</parameter>
<parameter name="outputformat" required="false" type="boolean">
<help><![CDATA[
A Boolean value that determines whether to create
WDDX (JavaScript) or ActionScript style output for
structures and queries.
Default: true
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="asformat" required="false" type="boolean">
<help><![CDATA[
A Boolean value that specifies whether to use
ActionScript shortcuts in the script.
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</function>
<!--
String ToString(any_value[, encoding])
-->
<function name="toString" returns="String" >
<help><![CDATA[
Converts a value to a string.
]]></help>
<parameter name="any_value" required="true" type="Object">
<help><![CDATA[
Value to convert to a string
]]></help>
</parameter>
<parameter name="encoding" required="false" type="String">
<help><![CDATA[
The character encoding (character set) of the string.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
</parameter>
</function>
<!--
String Trim(string)
-->
<function name="trim" returns="String" >
<help><![CDATA[
Removes leading and trailing spaces from a string.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one
]]></help>
</parameter>
</function>
<!--
String UCase(string)
-->
<function name="uCase" returns="String" >
<help><![CDATA[
Converts the alphabetic characters in a string to uppercase.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one
]]></help>
</parameter>
</function>
<!--
String URLDecode(urlEncodedString[, charset])
-->
<function name="urlDecode" returns="String" >
<help><![CDATA[
Decodes a URL-encoded string.
]]></help>
<parameter name="urlencodedstring" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="charset" required="false" type="String">
<help><![CDATA[
The character encoding in which the string is encoded.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
</parameter>
</function>
<!--
String URLEncodedFormat(string [, charset ])
-->
<function name="urlEncodedFormat" returns="String" >
<help><![CDATA[
Generates a URL-encoded string. For example, it replaces spaces
with %20, and non-alphanumeric characters with equivalent
hexadecimal escape sequences. Passes arbitrary strings within a
URL.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one
]]></help>
</parameter>
<parameter name="charset" required="false" type="String">
<help><![CDATA[
The character encoding in which the string is encoded.
]]></help>
<values>
<value option="utf-8"/>
<value option="iso-8859-1"/>
<value option="windows-1252"/>
<value option="us-ascii"/>
<value option="shift_jis"/>
<value option="iso-2022-jp"/>
<value option="euc-jp"/>
<value option="euc-kr"/>
<value option="big5"/>
<value option="euc-cn"/>
<value option="utf-16"/>
</values>
</parameter>
</function>
<!--
URL URLSessionFormat(request_URL)
-->
<function name="urlSessionFormat" returns="URL" >
<help><![CDATA[
Depending on whether a client computer accepts cookies, this
function does the following:
* If the client does not accept cookies: automatically appends
all required client identification information to a URL
* If the client accepts cookies: does not append information
]]></help>
<parameter name="requesturl" required="true" type="URL">
<help><![CDATA[
URL of a CFML page
]]></help>
<values>
<value option="cgi.script_name"/>
</values>
</parameter>
</function>
<!--
Numeric Val(string)
-->
<function name="val" returns="Numeric" >
<help><![CDATA[
Converts numeric characters that occur at the beginning of a
string to a number. If conversion fails, returns zero.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string or a variable that contains one
]]></help>
</parameter>
</function>
<!--
String ValueList(query.column [, delimiter ])
-->
<function name="valueList" returns="String" >
<help><![CDATA[
Inserts a delimiter between each value in an executed query.
CFML does not evaluate the arguments.
A delimited list of the values of each record returned from an
executed query
]]></help>
<parameter name="column" required="true" type="QueryColumn">
<help><![CDATA[
Name of an executed query and column. Separate query name
and column name with a period.
]]></help>
</parameter>
<parameter name="delimiter" required="false" type="String">
<help><![CDATA[
A delimiter character to separate column data items.
Default: comma (,).
]]></help>
<values default=",">
<value option=","/>
<value option="|"/>
<value option=";"/>
<value option="chr(9)"/>
<value option="chr(10)"/>
<value option="chr(13)"/>
</values>
</parameter>
</function>
<!--
Numeric Week(date)
-->
<function name="week" returns="Numeric" >
<help><![CDATA[
From a date/time object, determines the week number within
the year. An integer in the range 1-53; the ordinal of the
week, within the year.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
A date/time object in the range 100 AD-9999 AD.
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
String Wrap(string, limit[, strip])
-->
<function name="wrap" returns="String" >
<help><![CDATA[
Wraps text so that each line has a specified maximum number
of characters.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
String or variable that contains one. The text to wrap.
]]></help>
</parameter>
<parameter name="limit" required="true" type="Numeric">
<help><![CDATA[
Positive integer maximum number of characters to allow on
a line.
]]></help>
</parameter>
<parameter name="strip" required="false" type="boolean">
<help><![CDATA[
whether to remove all existing newline and carriage return
characters in the input string with spaces before wrapping
the text. Default: False.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</function>
<!--
String WriteOutput(string)
-->
<function name="writeOutput" returns="String" >
<help><![CDATA[
Appends text to the page-output stream.
This function writes to the page-output stream regardless of
conditions established by the cfsetting tag.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
A string, or a variable that contains one
]]></help>
</parameter>
</function>
<!--
Numeric XmlChildPos(elem, childName, N)
-->
<function name="xmlChildPos" returns="Numeric" >
<help><![CDATA[
Gets the position of a child element within an XML document
object.
The position, in an XmlChildren array, of the Nth child that
has the specified name.
]]></help>
<parameter name="elem" required="true" type="Node">
<help><![CDATA[
XML element within which to search
]]></help>
</parameter>
<parameter name="childname" required="true" type="String">
<help><![CDATA[
XML child element for which to search
]]></help>
</parameter>
<parameter name="n" required="true" type="Numeric">
<help><![CDATA[
Index of XMLchild element for which to search
]]></help>
</parameter>
</function>
<!--
Object XmlElemNew(xmlObj[, namespace], childName)
-->
<function name="xmlElemNew" returns="Object" >
<help><![CDATA[
Creates an XML document object element
]]></help>
<parameter name="xmlobj" required="true" type="Object">
<help><![CDATA[
The name of an XML object. An XML document or an element.
]]></help>
</parameter>
<parameter name="namespace" required="false" type="String">
<help><![CDATA[
URI of the namespace to which this element belongs.
]]></help>
</parameter>
<parameter name="childname" required="true" type="String">
<help><![CDATA[
The name of the element to create. This element becomes a
child element of xmlObj in the tree.
]]></help>
</parameter>
</function>
<!--
String XmlFormat(string)
-->
<function name="xmlFormat" returns="String" >
<help><![CDATA[
Escapes special XML characters in a string, so that the
string is safe to use with XML.
]]></help>
<parameter name="String" required="true" type="String">
<help><![CDATA[
]]></help>
</parameter>
<parameter name="escapeNewSet" required="false" type="boolean">
<help><![CDATA[
]]></help>
</parameter>
</function>
<!--
String XmlGetNodeType(xmlNode)
-->
<function name="xmlGetNodeType" returns="String" >
<help><![CDATA[
Determines the type of an XML document object node.
]]></help>
<parameter name="xmlNode" required="true" type="Object">
<help><![CDATA[
An XML DOM object node.
]]></help>
</parameter>
</function>
<!--
Object XmlNew([caseSensitive])
-->
<function name="xmlNew" returns="Object" >
<help><![CDATA[
Creates an XML document object.
]]></help>
<parameter name="casesensitive" required="false" type="boolean">
<help><![CDATA[
Maintains the case of document elements and attributes.
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</function>
<!--
Object XmlParse(xmlText[, caseSensitive[, validator]])
-->
<function name="xmlParse" returns="Object" >
<help><![CDATA[
Converts an XML document that is represented as a string
variable into an XML document object.
]]></help>
<parameter name="xmlstring" required="true" type="String">
<help><![CDATA[
Any of the following:
- A string containing XML text.
- The name of an XML file.
- The URL of an XML file; valid protocol identifiers
include http, https, ftp, and file.
]]></help>
</parameter>
<parameter name="casesensitive" required="false" type="boolean">
<help><![CDATA[
Maintains the case of document elements and attributes.
Default: false
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="validator" required="false" type="String">
<help><![CDATA[
Any of the following:
- The name of a Document Type Definition (DTD) or
XML Schema file.
- The URL of a DTD or Schema file; valid protocol
identifiers include http, https, ftp, and file.
- A string representation of a DTD or Schema.
- An empty string; in this case, the XML file must
contain an embedded DTD or Schema identifier, which
is used to validate the document.
]]></help>
</parameter>
</function>
<!--
Array XmlSearch(xmlDoc, xPathString)
-->
<function name="xmlSearch" returns="Array" >
<help><![CDATA[
]]></help>
<parameter name="xmldoc" required="true" type="Object">
<help><![CDATA[
XML document object
]]></help>
</parameter>
<parameter name="xpathstring" required="true" type="String">
<help><![CDATA[
XPath expression
]]></help>
</parameter>
</function>
<!--
String XmlTransform(xml, xsl[, parameters])
-->
<function name="xmlTransform" returns="String" >
<help><![CDATA[
Applies an Extensible Stylesheet Language Transformation (XSLT)
to an XML document object that is represented as a string
variable. An XSLT converts an XML document to another format
or representation by applying an Extensible Stylesheet
Language (XSL) stylesheet to it.
]]></help>
<parameter name="xml" required="true" type="String">
<help><![CDATA[
An XML document in string format, or an XML document object.
]]></help>
</parameter>
<parameter name="xsl" required="true" type="String">
<help><![CDATA[
XSLT transformation to apply; can be any of the following:
- A string containing XSL text.
- The name of an XSTLT file. Relative paths start at
the directory containing the current CFML page.
- The URL of an XSLT file; valid protocol identifiers
include http, https, ftp, and file. Relative paths start
at the directory containing the current CFML page.
]]></help>
</parameter>
<parameter name="parameters" required="false" type="Struct">
<help><![CDATA[
A structure containing XSL template parameter name-value
pairs to use in transforming the document. The XSL transform
defined in the xslString parameter uses these parameter values
in processing the xml.
]]></help>
</parameter>
</function>
<!--
Struct XmlValidate(xmlDoc[, validator])
-->
<function name="xmlValidate" returns="Struct" >
<help><![CDATA[
Uses a Document Type Definition (DTD) or XML Schema
to validate an XML text document or an XML document object.
]]></help>
<parameter name="xmlDoc" required="true" type="Object">
<help><![CDATA[
Any of the following:
- A string containing an XML document.
- The name of an XML file.
- The URL of an XML file; valid protocol identifiers
include http, https, ftp, and file.
- An XML document object, such as one generated by
the XmlParse function.
]]></help>
</parameter>
<parameter name="validator" required="false" type="String">
<help><![CDATA[
Any of the following:
- A string containing a DTD or Schema.
- The name of a DTD or Schema file.
- The URL of a DTD or Schema file; valid protocol
identifiers include http, https, ftp, and file.
]]></help>
</parameter>
</function>
<!--
Numeric Year(date)
-->
<function name="year" returns="Numeric" >
<help><![CDATA[
From a date/time object, gets the year value.
]]></help>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
]]></help>
<values>
<value option="now()"/>
</values>
</parameter>
</function>
<!--
String YesNoFormat(value)
-->
<function name="yesNoFormat" returns="String" >
<help><![CDATA[
Yes, for a non-zero value; No, otherwise.
]]></help>
<parameter name="value" required="true" type="boolean">
<help><![CDATA[
A number or Boolean value
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</function>
<function name="spreadsheetGetCellFormula" returns="String">
<help><![CDATA[
Gets the formula for a for an Excel spreadsheet object cell, or all formulas for the object.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="row" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="column" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadSheetReadBinary" returns="void">
<help><![CDATA[
Reads spreadsheet file into a binary object
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
Spreadsheet file
]]></help>
</parameter>
</function>
<function name="spreadSheetInfo" returns="Struct">
<help><![CDATA[
Returns spreadsheet property
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadSheetAddSplitPane" returns="void">
<help><![CDATA[
Adds split pane to spreadsheet.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
Spreadsheet variable
]]></help>
</parameter>
<parameter name="x" required="true" type="Numeric">
<help><![CDATA[
X position for split
]]></help>
</parameter>
<parameter name="y" required="true" type="Numeric">
<help><![CDATA[
Y position for split
]]></help>
</parameter>
<parameter name="splitColumn" required="true" type="Numeric">
<help><![CDATA[
Split Column
]]></help>
</parameter>
<parameter name="splitRow" required="true" type="Numeric">
<help><![CDATA[
Split Row
]]></help>
</parameter>
<parameter name="position" required="false" type="String">
<help><![CDATA[
Specify which pane has the focus
]]></help>
<values>
<value option="LOWER_LEFT" />
<value option="LOWER_RIGHT" />
<value option="UPPER_LEFT" />
<value option="UPPER_RIGHT" />
</values>
</parameter>
</function>
<function name="spreadSheetAddFreezePane" returns="void">
<help><![CDATA[
Adds freeze pane to spreadsheet
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
Spreadsheet variable
]]></help>
</parameter>
<parameter name="column" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="row" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="endColumn" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="endRow" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetAddImage" returns="void">
<help><![CDATA[
Adds an image to an Excel spreadsheet object.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="imagedata" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="imagetype" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="anchor" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetAddimage" returns="void">
<help><![CDATA[
Adds an image to an Excel spreadsheet object.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="imagefilepath" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="anchor" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetAddInfo" returns="void">
<help><![CDATA[
Adds information to an Excel spreadsheet object.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="info" required="true" type="Struct">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetCreateSheet" returns="void">
<help><![CDATA[
Create spreadsheet from given spreadsheet object
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetSetActiveSheet" returns="void">
<help><![CDATA[
Sets active sheet in given spreadsheet
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="name" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetSetActiveSheetNumber" returns="void">
<help><![CDATA[
Sets number of active sheet in given spreadsheet
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="number" required="false" type="Number">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetMergeCells" returns="void">
<help><![CDATA[
Merges a rectangular block of two or more Excel spreadsheet object cells.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="startrow" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="endrow" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="startcolumn" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="endcolumn" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetDeleteRow" returns="void">
<help><![CDATA[
Deletes all data from a row of an Excel spreadsheet object. It does not delete the row.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="row" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="ormGetSession" returns="">
<help><![CDATA[
No Help Available
]]></help>
</function>
<function name="imageCopy" returns="Image">
<help><![CDATA[
Copies a rectangular area of an image.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
The ColdFusion image on which this operation is performed.
]]></help>
</parameter>
<parameter name="x" required="true" type="Numeric">
<help><![CDATA[
The x coordinate of the source rectangle.
]]></help>
</parameter>
<parameter name="y" required="true" type="Numeric">
<help><![CDATA[
The y coordinate of the source rectangle.
]]></help>
</parameter>
<parameter name="width" required="true" type="Numeric">
<help><![CDATA[
The width of the source rectangle.
]]></help>
</parameter>
<parameter name="height" required="true" type="Numeric">
<help><![CDATA[
The height of the source rectangle.
]]></help>
</parameter>
<parameter name="dx" required="false" type="Numeric">
<help><![CDATA[
The x coordinate of the destination rectangle.
]]></help>
</parameter>
<parameter name="dy" required="false" type="Numeric">
<help><![CDATA[
The y coordinate of the destination rectangle.
]]></help>
</parameter>
</function>
<function name="imageTranslate" returns="void">
<help><![CDATA[
Copies an image to a new location on the plane.
]]></help>
<parameter name="name" required="true" type="String" >
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="xTrans" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="yTrans" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="interpolation" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageDrawLines" returns="void">
<help><![CDATA[
Draws a sequence of connected lines defined by arrays of x and y coordinates.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="xcords" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="ycords" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="isPolygon" required="false" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="filled" required="false" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageScaleTofit" returns="void">
<help><![CDATA[
Creates a resized image with the aspect ratio maintained.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="fitWidth" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="fitHeight" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="interpolation" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="blurFactor" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="cacheRemove" returns="void">
<help><![CDATA[
Removes an object from the cache .
]]></help>
<parameter name="ids" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="throwOnError" required="false" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="getFileInfo" returns="Map">
<help><![CDATA[
Retrieves information about on-disk or in-memory file.
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetAddRows" returns="void">
<help><![CDATA[
Adds multiple rows from a query to an Excel spreadsheet object.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="data" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="row" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="insert" required="false" type="boolean">
<help><![CDATA[
No Help Available
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
</function>
<function name="cachePut" returns="void">
<help><![CDATA[
Stores an object in the cache.
]]></help>
<parameter name="id" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="timespan" required="false" type="DateTime">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="idelTime" required="false" type="DateTime">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageGetIPTCtag" returns="String">
<help><![CDATA[
Retrieves the value of the IPTC tag for a ColdFusion image.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="tagName" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="sleep" returns="void">
<help><![CDATA[
No Help Available
]]></help>
<parameter name="Param1" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="threadJoin" returns="void">
<help><![CDATA[
No Help Available
]]></help>
<parameter name="Param1" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="fileMove" returns="void">
<help><![CDATA[
Moves file from source to destination
]]></help>
<parameter name="source" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="destination" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="fileSeek" returns="void">
<help><![CDATA[
Shifts the file pointer to the given position. The file must be opened with seekable option
]]></help>
<parameter name="file" required="true" type="variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="position" required="true" type="numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="fileSkipBytes" returns="void">
<help><![CDATA[
Shifts the file pointer by the given number of bytes.
]]></help>
<parameter name="file" required="true" type="variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="bytes" required="true" type="numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetShiftRows" returns="void">
<help><![CDATA[
shifts one or more rows in Excel spreadsheet object up or down. . The contents of the shifted row, including empty cells, overwrites data in the column to which it is shfted.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="start" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="end" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="rows" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageFlip" returns="void">
<help><![CDATA[
Flips an image across an axis.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="transpose" required="true" type="String" >
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageTranslateDrawingAxis" returns="void">
<help><![CDATA[
Translates the origin of the image context to the point (x,y) in the current coordinate system. Modifies the image context so that its new origin corresponds to the point (x,y) in the image's original coordinate system.
]]></help>
<parameter name="Param1" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetFormatRows" returns="void">
<help><![CDATA[
Formats the contents of a multipe rows of an Excel spreadsheet object.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="format" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="row" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetSetCellFormula" returns="void">
<help><![CDATA[
Specifies the formula for an Excel spreadsheet object cell.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="formula" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="row" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="column" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="arrayDeleteAt" returns="boolean" >
<help><![CDATA[
Deletes an element from an array and resizes the array
so that the deleted element doesn't leave a gap.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
The array that the element will be deleted from.
]]></help>
</parameter>
<parameter name="position" required="true" type="Numeric">
<help><![CDATA[
The numeric position of the element. Remember that
ColdFusion arrays start at 1 not 0.
]]></help>
</parameter>
</function>
<function name="imageGetEXIFTag" returns="String">
<help><![CDATA[
Retrieves the specified EXIF tag in an image.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="tagName" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="ImageGetExifMetaData" returns="Struct">
<help><![CDATA[
Retrieves the Exchangeable Image File Format (EXIF) headers in an image as a CFML structure.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="ImageGetIptcMetaData" returns="Struct">
<help><![CDATA[
Retrieves the International Press Telecommunications Council (IPTC )headers in a ColdFusion image as a structure.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="fileWriteLine" returns="void">
<help><![CDATA[
No Help Available
]]></help>
<parameter name="file" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="content" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="ormClearSession" returns="void">
<help><![CDATA[
No Help Available
]]></help>
</function>
<function name="fileDelete" returns="void">
<help><![CDATA[
No Help Available
]]></help>
<parameter name="file" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageWrite" returns="void">
<help><![CDATA[
Writes a ColdFusion image to the specified filename or destination.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="destination" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="quality" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="overwrite" required="false" type="boolean">
<help><![CDATA[
No Help Available
]]></help>
<values default="true">
<value option="false" />
<value option="true" />
</values>
</parameter>
</function>
<function name="trace" returns="void">
<help><![CDATA[
Displays and logs debugging data about the state of an
application at the time the cftrace tag executes. Tracks
runtime logic flow, variable values, and execution time.
Displays output at the end of the request or in the debugging
section at the end of the request;
CFML logs cftrace output to the file logs\cftrace.log, in
the CFML installation directory.
Note: To permit this tag to execute, you must enable debugging
in the CFML Administrator. Optionally, to report trace
summaries, enable the Trace section.
]]></help>
<parameter name="abort" required="false" type="boolean">
<help><![CDATA[
Calls cfabort tag when the tag is executed
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="category" required="false" type="String">
<help><![CDATA[
User-defined string for identifying trace groups
]]></help>
<values/>
</parameter>
<parameter name="inline" required="false" type="boolean">
<help><![CDATA[
Displays trace code in line on the page in the
location of the cftrace tag, addition to the debugging
information output.
]]></help>
<values default="false">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="text" required="false" type="String">
<help><![CDATA[
User-defined string, which can include simple variable,
but not complex variables such as arrays. Outputs to cflog
text attribute
]]></help>
<values/>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
Corresponds to the cflog type attribute; displays an
appropriate icon.
* Information
* Warning
* Error
* Fatal Information
]]></help>
<values default="information">
<value option="information"/>
<value option="warning"/>
<value option="error"/>
<value option="fatal information"/>
</values>
</parameter>
<parameter name="var" required="false" type="String">
<help><![CDATA[
The name of a simple or complex variable to display.
Useful for displaying a temporary value, or a value that
does not display on any CFM page.
]]></help>
<values/>
</parameter>
</function>
<function name="transactionCommit" returns="void">
<help><![CDATA[
No Help Available
]]></help>
</function>
<function name="imageSetAntialiasing" returns="void">
<help><![CDATA[
Switches antialiasing on or off in rendered graphics.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="antialias" required="false" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="entitySave" returns="void">
<help><![CDATA[
Saves or updates data of the entity and all related entities to the database.
EntitySave(entity, [forceinsert])
]]></help>
<parameter name="entity" required="true" type="Variablename">
<help><![CDATA[
Name of the entity that must be saved in the database.
]]></help>
</parameter>
<parameter name="forceInsert" required="false" type="Boolean">
<help><![CDATA[
If true, then ColdFusion always tries to insert the entity as a new record.
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
</function>
<function name="cacheSetProperties" returns="void">
<help><![CDATA[
No Help Available
]]></help>
<parameter name="Param1" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageSharpen" returns="void">
<help><![CDATA[
Sharpens a ColdFusion image by using the unsharp mask filter.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="gain" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetNew" returns="">
<help><![CDATA[
Creates a ColdFusion spreadsheet object, which represents a single sheet of an Excel document.
]]></help>
<parameter name="sheetname" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="xmlFormat" required="false" type="boolean">
<help><![CDATA[
No Help Available
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
</function>
<function name="imageBlur" returns="void">
<help><![CDATA[
Smooths (blurs) the ColdFusion image.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="blurradius" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageSetDrawingStroke" returns="void">
<help><![CDATA[
Sets the drawing stroke for points and lines in subsequent ColdFusion images.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="attributecollection" required="false" type="Struct">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="ormCloseSession" returns="void">
<help><![CDATA[
No Help Available
]]></help>
</function>
<function name="spreadsheetFormatRow" returns="void">
<help><![CDATA[
Formats the contents of a single row of an Excel spreadsheet object.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="format" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="row" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="getWriteableImageFormats" returns="String">
<help><![CDATA[
No Help Available
]]></help>
</function>
<function name="fileReadLine" returns="String">
<help><![CDATA[
No Help Available
]]></help>
<parameter name="Param1" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="fileOpen" returns="">
<help><![CDATA[
No Help Available
]]></help>
<parameter name="Param1" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="Param2" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="Param3" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageCrop" returns="void">
<help><![CDATA[
Crops a ColdFusion image to a specified rectangular area.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="width" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="height" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageRead" returns="Image">
<help><![CDATA[
Reads the source pathname or URL and creates a ColdFusion image.
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="isImageFile" returns="boolean">
<help><![CDATA[
Verifies whether an image file is valid.
]]></help>
<parameter name="path" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageDrawArc" returns="void">
<help><![CDATA[
Draws a circular or elliptical arc.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="width" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="height" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="startAngle" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="archAngle" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="filled" required="false" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="ormFlush" returns="void">
<help><![CDATA[
No Help Available
]]></help>
</function>
<function name="objectEquals" returns="boolean">
<help><![CDATA[
No Help Available
]]></help>
<parameter name="Param1" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="Param2" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageShear" returns="void">
<help><![CDATA[
Shears an image either horizontally or vertically.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="shear" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="direction" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="interpolation" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageClearRect" returns="void">
<help><![CDATA[
Clears the specified rectangle by filling it with the background color of the current drawing surface.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="width" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="height" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="isSpreadsheetObject" returns="boolean">
<help><![CDATA[
Checks if given object is spreadsheet object or not
]]></help>
<parameter name="object" required="true" type="Variablename">
<help><![CDATA[
Any Object
]]></help>
</parameter>
</function>
<function name="isSpreadsheetFile" returns="boolean">
<help><![CDATA[
Checks if given file is spreadsheet file or not
]]></help>
<parameter name="file" required="true" type="String">
<help><![CDATA[
Any file
]]></help>
</parameter>
</function>
<function name="imageDrawOval" returns="void">
<help><![CDATA[
Draws an oval.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="width" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="height" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="filled" required="false" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="arrayFind" returns="Numeric">
<help><![CDATA[
These functions searches the array for the specified object.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="object" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="arrayFindNoCase" returns="Numeric">
<help><![CDATA[
These functions performs a case-insensitive search in the array for the specified object.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="object" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageDrawQuadraticCurve" returns="void">
<help><![CDATA[
Draws a curved line. The curve is controlled by a single point.
]]></help>
<parameter name="name" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="ctrlx1" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="ctrly1" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="ctrlx2" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="ctrly2" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x1" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y1" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x2" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y2" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="entityLoadByExample" returns="Object">
<help><![CDATA[
Loads and returns an array of objects that match the sampleentity.
entityLoadByExample(sampleEntity,[unique])
]]></help>
<parameter name="sampleEntity" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="unique" required="false" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="entityLoadByPK" returns="Object">
<help><![CDATA[
Loads and returns an array of objects for given primary key.
]]></help>
<parameter name="entityName" required="true" type="String">
<help><![CDATA[
Name of the entity to be loaded.
]]></help>
</parameter>
<parameter name="id" required="true" type="Object">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageDrawCubicCurve" returns="void">
<help><![CDATA[
Draws a cubic curve.
]]></help>
<parameter name="name" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="ctrlx1" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="ctrly1" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="ctrlx2" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="ctrly2" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x1" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y1" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x2" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y2" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageReadBase64" returns="Image">
<help><![CDATA[
Creates a ColdFusion image from a Base64 string.
]]></help>
<parameter name="string" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="fileSetLastModified" returns="void">
<help><![CDATA[
Sets the date when an on-disk or in-memory file was most recently modified.
]]></help>
<parameter name="filePath" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="date" required="true" type="DateTime">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageResize" returns="void">
<help><![CDATA[
Resizes a ColdFusion image.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="width" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="height" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="interpolation" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="blurfactor" required="true" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="addSOAPRequestHeader" returns="boolean">
<help><![CDATA[
Adds a SOAP header to a web service request before making the request.
]]></help>
<parameter name="webservice" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="namespace" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="mustunderstand" required="true" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="threadTerminate" returns="void">
<help><![CDATA[
Terminates the thread specified by the threadName parameter.
]]></help>
<parameter name="threadname" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="fileWrite" returns="void">
<help><![CDATA[
If you specify a file path, writes the entire content to the specified on-disk or in-memory file. If you specify a file object, writes text or binary data to the file object.
]]></help>
<parameter name="filePath" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="data" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="charset" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageRotateDrawingAxis" returns="void">
<help><![CDATA[
Rotates all subsequent drawing on a ColdFusion image at a specified point by a specified angle.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="angle" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="fileCopy" returns="void">
<help><![CDATA[
Copies the specified on-disk or in-memory source file to the specified destination file.
]]></help>
<parameter name="source" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="destination" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="fileRead" returns="String">
<help><![CDATA[
Reads an on-disk or in-memory text file or a file object created with the FileOpen function.
]]></help>
<parameter name="filepath" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="charset" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="cacheGet" returns="">
<help><![CDATA[
Gets an object that is stored in the cache.
]]></help>
<parameter name="id" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="fileSetAccessMode" returns="void">
<help><![CDATA[
Sets the attributes of an on-disk file on UNIX or Linux. This function does not work with in-memory files.
]]></help>
<parameter name="filePath" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="mode" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="fileSetAttribute" returns="void">
<help><![CDATA[
Sets the attributes of an on-disk file in Windows. This function does not work with in-memory files.
]]></help>
<parameter name="filePath" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="attribute" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetGetCellComment" returns="Array">
<help><![CDATA[
Gets the comment for an Excel spreadsheet object cell as a structure with formatting information, or all comments for the object.
]]></help>
<parameter name="author" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="column" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="comment" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="row" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<!-- <function name="arrayContains" returns="boolean">
<help><![CDATA[
No Help Available
]]></help>
<parameter name="Param1" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="Param2" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function> -->
<function name="imageDrawRoundRect" returns="void">
<help><![CDATA[
Draws a rectangle with rounded corners.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="width" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="height" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="arcwidth" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="archeight" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="filled" required="false" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="objectSave" returns="Binary">
<help><![CDATA[
Serialize object to file or convert it to binary format
]]></help>
<parameter name="object" required="true" type="Variablename">
<help><![CDATA[
Object to be serialized
]]></help>
</parameter>
<parameter name="file" required="false" type="String">
<help><![CDATA[
File in which serialized object will be stored
]]></help>
</parameter>
</function>
<function name="objectLoad" returns="">
<help><![CDATA[
Load object from file
]]></help>
<parameter name="filePath" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="objectload" returns="">
<help><![CDATA[
Load object from binary obj
]]></help>
<parameter name="binaryObject" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="transactionRollback" returns="void">
<help><![CDATA[
Rollback current transaction
]]></help>
<parameter name="savepoint" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetFormatColumns" returns="void">
<help><![CDATA[
Formats the contents of a multipe columns of an Excel spreadsheet object.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="format" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="columns" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="isImage" returns="boolean">
<help><![CDATA[
Determines whether a variable returns a ColdFusion image.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetDeleteColumn" returns="void">
<help><![CDATA[
Deletes the data from a column of an Excel spreadsheet object. It does not delete the column.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="column" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="transactionSetSavepoint" returns="void">
<help><![CDATA[
Set savepoint for transaction
]]></help>
<parameter name="savepoint" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetFormatColumn" returns="void">
<help><![CDATA[
Formats the contents of a single column of an Excel spreadsheet object.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="format" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="column" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="arrayInsertAt" returns="boolean" >
<help><![CDATA[
Inserts a value at the specified position in the array. If
the element is inserted before the end of the array, ColdFusion
shifts the positions of all elements with a higher index to make room.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
The array which will have the new element inserted.
]]></help>
</parameter>
<parameter name="position" required="true" type="Numeric">
<help><![CDATA[
The numerical index in the array where the new element will be inserted.
Must be less than or equal to the length of the array.
Remember ColdFusion arrays start at 1 not 0.
]]></help>
</parameter>
<parameter name="value" required="true" type="Any">
<help><![CDATA[
The new element to insert.
]]></help>
</parameter>
</function>
<function name="arrayIsDefined" returns="boolean">
<help><![CDATA[
Determines whether an array element is defined.
]]></help>
<parameter name="array" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="elementIndex" required="true" type="Numeric" >
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="arrayIsEmpty" returns="boolean" >
<help><![CDATA[
Determines whether an array is empty. Equivalent to arrayLen().
Calling this function on an array with 10 undefined elements
will return false.
CFML MX: this function can be used on XML objects.
]]></help>
<parameter name="array" required="true" type="Array">
<help><![CDATA[
]]></help>
</parameter>
</function>
<function name="spreadsheetSetCellComment" returns="void">
<help><![CDATA[
Specifies the comment for an Excel spreadsheet object cell.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="comment" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="row" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="column" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetAddColumn" returns="void">
<help><![CDATA[
Adds a column or column data to an Excel spreadsheet object.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="data" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="startrow" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="startcolumn" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="insert" required="true" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="insert" required="false" type="boolean">
<help><![CDATA[
No Help Available
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
</function>
<function name="getReadableImageFormats" returns="String">
<help><![CDATA[
Returns a list of image formats that ColdFusion can read on the operating system where ColdFusion is deployed.
]]></help>
</function>
<function name="imageNegative" returns="void">
<help><![CDATA[
Inverts the pixel values of a ColdFusion image.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetShiftColumns" returns="void">
<help><![CDATA[
shifts one or more columns in Excel spreadsheet object left or right.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="start" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="end" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="start" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="cacheGetMetadata" returns="Map">
<help><![CDATA[
Gets the metadata values for a cached object.
]]></help>
<parameter name="id" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="ormExecuteQuery" returns="">
<help><![CDATA[
Runs the HQL on the default data source specified for the application.
]]></help>
<parameter name="hql" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="unique" required="false" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="queryoptions" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="ormEvictEntity" returns="">
<help><![CDATA[
This will remove all the entries for the specified component name from the entity cache.
ormEvictEntity(componentName,[id])
]]></help>
<parameter name="componentName" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="id" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="ormEvictCollection" returns="">
<help><![CDATA[
This will remove all the entries with the specified relation/collection name in the specified component.
ormEvictCollection(componentName,relationName,[id])
]]></help>
<parameter name="componentName" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="relationName" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="id" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="ormEvictQueries" returns="">
<help><![CDATA[
This will remove all the queries from the named query cache.
If name is not specified, all quiries from default cache will be removed.
ormEvictQueries([cacheName])
]]></help>
<parameter name="cacheName" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="ormGetSessionFactory" returns="Object">
<help><![CDATA[
Returns ORM session factory instance
]]></help>
</function>
<function name="ormReload" returns="void">
<help><![CDATA[
Returns ORM session factory instance
]]></help>
</function>
<function name="entityDelete" returns="void">
<help><![CDATA[
Deletes the record from the database for the specified entity.
EntityDelete(entity)
]]></help>
<parameter name="entity" required="true" type="Variablename">
<help><![CDATA[
Name of the entity being deleted.
]]></help>
</parameter>
</function>
<function name="entityToQuery" returns="query">
<help><![CDATA[
Converts the input entity object or the input array of entity objects to a query object.
EntitytoQuery (orm_object, [entity_name])
EntitytoQuery (orm_object_array, [entity_name])
]]></help>
<parameter name="orm_object" required="true" type="Variablename">
<help><![CDATA[
Entity object that needs to be converted to a query object.
]]></help>
</parameter>
<parameter name="entity_name" required="false" type="String">
<help><![CDATA[
Name of the entity. Use this optional parameter to return the query of the given entity in the case of inheritance mapping.
]]></help>
</parameter>
</function>
<function name="imageGetBlob" returns="">
<help><![CDATA[
Retrieves the bytes of the underlying image. The bytes are in the same image format as the source image.
]]></help>
<parameter name="source" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageSetBackgroundColor" returns="void">
<help><![CDATA[
Sets the background color for the ColdFusion image. The background color is used for clearing a region. Setting the background color only affects the subsequent ImageClearRect calls
]]></help>
<parameter name="name" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="color" required="true">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="isIPV6" returns="boolean">
<help><![CDATA[
checks if given IP is of IPV6 format
]]></help>
<parameter name="IP" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageDrawPoint" returns="void">
<help><![CDATA[
Draws a point at the specified (x,y) coordinate.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageSetDrawingTransparency" returns="void">
<help><![CDATA[
Specifies the degree of transparency of drawing functions.
]]></help>
<parameter name="name" required="true" type="Stirng">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="percent" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageRotate" returns="void">
<help><![CDATA[
Rotates a ColdFusion image at a specified point by a specified angle.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="angle" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="interpolation" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageOverlay" returns="void">
<help><![CDATA[
Reads two source ColdFusion images and overlays the second source image on the first source image.
]]></help>
<parameter name="source1" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="source2" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="fileReadBinary" returns="">
<help><![CDATA[
Reads an on-disk or in-memory binary file (such as an executable or image file) on the server, into a binary object
]]></help>
<parameter name="filePath" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageSetDrawingColor" returns="void">
<help><![CDATA[
Sets the current drawing color for ColdFusion images. All subsequent graphics operations use the specified color.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="color" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageDrawLine" returns="void">
<help><![CDATA[
Draws a single line defined by two sets of x and y coordinates on a ColdFusion image.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x1" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y1" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x2" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y2" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageShearDrawingAxis" returns="void">
<help><![CDATA[
Shears the drawing canvas.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="shrx" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="shry" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetSetCellValue" returns="void">
<help><![CDATA[
Specifies the value of an Excel spreadsheet object cell.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="row" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="column" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetSetColumnWidth" returns="void">
<help><![CDATA[
Sets the width of a column in a worksheet.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
The Excel spreadsheet object to which to set the column width.
]]></help>
</parameter>
<parameter name="columnNumber" required="true" type="Numeric">
<help><![CDATA[
Specifies the column to set the width.
]]></help>
</parameter>
<parameter name="width" required="true" type="Numeric">
<help><![CDATA[
Specifies the width in points.
]]></help>
</parameter>
</function>
<function name="spreadsheetSetRowHeight" returns="void">
<help><![CDATA[
Sets the height of a row in a worksheet.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
The Excel spreadsheet object to which to set the column width.
]]></help>
</parameter>
<parameter name="rowNumber" required="true" type="Numeric">
<help><![CDATA[
Specifies the row to set the height.
]]></help>
</parameter>
<parameter name="height" required="true" type="Numeric">
<help><![CDATA[
Specifies the height in points.
]]></help>
</parameter>
</function>
<function name="spreadsheetSetHeader" returns="void">
<help><![CDATA[
Adds a header to the specified worksheet.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
The Excel spreadsheet object to which to add the header.
]]></help>
</parameter>
<parameter name="leftHeader" required="true" type="String">
<help><![CDATA[
Adds the header in the left side of the worksheet.
]]></help>
</parameter>
<parameter name="centerHeader" required="true" type="String">
<help><![CDATA[
Adds the header in the center of the worksheet.
]]></help>
</parameter>
<parameter name="rightHeader" required="true" type="String">
<help><![CDATA[
Adds the header in the right side of the worksheet.
]]></help>
</parameter>
</function>
<function name="spreadsheetSetFooter" returns="void">
<help><![CDATA[
Adds a footer to the specified worksheet.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
The Excel spreadsheet object to which to add the footer.
]]></help>
</parameter>
<parameter name="leftFooter" required="true" type="String">
<help><![CDATA[
Adds the footer in the left side of the worksheet.
]]></help>
</parameter>
<parameter name="centerFooter" required="true" type="String">
<help><![CDATA[
Adds the footer in the center of the worksheet.
]]></help>
</parameter>
<parameter name="rightFooter" required="true" type="String">
<help><![CDATA[
Adds the footer in the right side of the worksheet.
]]></help>
</parameter>
</function>
<function name="imageGetBufferedImage" returns="Image">
<help><![CDATA[
Returns the java.awt.BufferedImage object underlying the current ColdFusion image.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="getPrinterInfo" returns="Struct">
<help><![CDATA[
Determines which print attributes are supported by a selected printer.
]]></help>
<parameter name="printer" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="getPrinterList" returns="String">
<help><![CDATA[
Returns list of printers accessible by the ColdFusion server
]]></help>
<parameter name="printer" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="addSOAPResponseHeader" returns="boolean">
<help><![CDATA[
Adds a SOAP response header to a web service response. Call only from within a CFC web service function that is processing a request as a SOAP web service.
]]></help>
<parameter name="namespace" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="value" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="mustunderstand" required="false" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageAddBorder" returns="void">
<help><![CDATA[
Adds a rectangular border around the outside edge of a ColdFusion image.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="thickness" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="color" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="bordertype" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetGetCellValue" returns="String">
<help><![CDATA[
Gets the Value for a for an Excel spreadsheet object cell.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="row" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="column" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageInfo" returns="Struct">
<help><![CDATA[
Returns a structure that contains information about the image, such as height, width, color model, size, and filename.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="cacheGetProperties" returns="Map">
<help><![CDATA[
Gets the cache properties for the object cache, the page cache, or both. The information is application-specific.
]]></help>
<parameter name="type" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="cacheGetAllIds" returns="">
<help><![CDATA[
Gets the IDs of all objects stored in the cache.
]]></help>
</function>
<function name="entityLoad" returns="">
<help><![CDATA[
Loads and returns an array of entities of the specified entityname.
EntityLoad (entityname)
EntityLoad (entityname, id [, unique])
]]></help>
<parameter name="entityName" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="id" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="unique" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="entityload" returns="">
<help><![CDATA[
Loads and returns an array of entities of the specified entityname.
EntityLoad (entityname, filtercriteria [,unique]
EntityLoad(entityname, filtercriteria, sortorder [, options])
]]></help>
<parameter name="entityName" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="filtercriteria" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="unique" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="sortorder" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="options" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="entityNew" returns="Object">
<help><![CDATA[
Creates a new instance of the persistent CFC with the entity name that you provide.
]]></help>
<parameter name="entityName" required="true" type="String">
<help><![CDATA[
Entity name of the persistent CFC.
]]></help>
</parameter>
</function>
<function name="entityMerge" returns="Object">
<help><![CDATA[
Attaches given enity to current ORM session
]]></help>
<parameter name="entity" required="true" type="Variablename">
<help><![CDATA[
The entity that must be attached to the ORM session.
]]></help>
</parameter>
</function>
<function name="imageGetWidth" returns="Numeric">
<help><![CDATA[
Retrieves the width of the specified ColdFusion image.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageXORDrawingMode" returns="void">
<help><![CDATA[
Sets the paint mode of the image to alternate between the image's current color and the new specified color.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="c1" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageDrawRect" returns="void">
<help><![CDATA[
Draws a rectangle.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="width" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="height" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="filled" required="false" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="queryConvertForGrid" returns="Struct">
<help><![CDATA[
Converts query data to a structure that contains a paged subset of the query.
]]></help>
<parameter name="query" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="page" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="pageSize" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="isUserInAnyRole" returns="boolean">
<help><![CDATA[
Determines whether an authenticated user belongs to any role in a list of roles.
]]></help>
<parameter name="roleList" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="entityReload" returns="void">
<help><![CDATA[
Reloads data for an entity that is already loaded.
]]></help>
<parameter name="entity" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetDeleteColumns" returns="void">
<help><![CDATA[
Deletes the data from multiple columns of an Excel spreadsheet object. This function does not remove the columns.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="range" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageGetHeight" returns="Numeric">
<help><![CDATA[
Retrieves the height of the ColdFusion image in pixels.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="fileClose" returns="void">
<help><![CDATA[
Closes an on-disk or in-memory file that is open.
]]></help>
<parameter name="fileObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetFormatCell" returns="void">
<help><![CDATA[
Formats the contents of a single cell of an Excel spreadsheet object.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="format" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="row" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="column" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imagePaste" returns="void">
<help><![CDATA[
Takes two images and an (x,y) coordinate and draws the second image over the first image with the upper-left corner at coordinate (x,y).
]]></help>
<parameter name="image1" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="image2" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetAddRow" returns="void">
<help><![CDATA[
Adds a row to an Excel spreadsheet object.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="data" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="row" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="column" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="insert" required="false" type="boolean">
<help><![CDATA[
No Help Available
]]></help>
<values>
<value option="true" />
<value option="false" />
</values>
</parameter>
</function>
<function name="spreadsheetDeleteRows" returns="void">
<help><![CDATA[
Deletes all data from multiple rows of an Excel spreadsheet object. It does not delete the row.
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="range" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetwrite" returns="void">
<help><![CDATA[
Writes Spreadsheet object into file
]]></help>
<parameter name="spreadsheetObj" required="true" type="Variablename">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="fileName" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="password" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="overwrite" required="false" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="spreadsheetRead" returns="void">
<help><![CDATA[
Create a new spreadsheet variable from specified file
]]></help>
<parameter name="fileName" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="spreadsheetObj" required="true" returnType="variablename" type="Variablename">
<help><![CDATA[
Spreadsheet name or number
]]></help>
</parameter>
</function>
<function name="imageDrawText" returns="void">
<help><![CDATA[
Draws a text string on a ColdFusion image with the baseline of the first character positioned at (x,y) in the image.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="str" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="attributecollection" required="true" type="Struct">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageDrawBeveledRect" returns="void">
<help><![CDATA[
Draws a rectangle with beveled edges.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="x" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="y" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="width" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="height" required="true" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="raised" required="true" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="filled" required="false" type="Boolean">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageNew" returns="Image">
<help><![CDATA[
Creates a ColdFusion image.
]]></help>
<parameter name="source" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="width" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="height" required="false" type="Numeric">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="imagetype" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="canvascolor" required="false" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageGrayScale" returns="void">
<help><![CDATA[
Converts a ColdFusion image to grayscale.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
</function>
<function name="imageWriteBase64" returns="void">
<help><![CDATA[
Writes Base64 images to the specified filename and destination.
]]></help>
<parameter name="name" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="destination" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="format" required="true" type="String">
<help><![CDATA[
No Help Available
]]></help>
</parameter>
<parameter name="inHTMLFormat" required="false" type="boolean">
<help><![CDATA[
No Help Available
]]></help>
<values default="false">
<value option="false" />
<value option="true" />
</values>
</parameter>
<parameter name="overwrite" required="false" type="boolean">
<help><![CDATA[
No Help Available
]]></help>
<values default="true">
<value option="false" />
<value option="true" />
</values>
</parameter>
</function>
<function name="writeDump" returns="void" >
<help><![CDATA[
Outputs the elements, variables and values of most kinds of
CFML objects. Useful for debugging. You can display the
contents of simple and complex variables, objects, components,
user-defined functions, and other elements.
]]></help>
<parameter name="var" required="true" type="variablename">
<help><![CDATA[
Variable to display. Enclose a variable name in pound
signs.
]]></help>
<values/>
</parameter>
<parameter name="expand" required="false" type="boolean">
<help><![CDATA[
Yes: In Internet Explorer and Mozilla, expands views
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="format" required="false" type="String">
<help><![CDATA[
specify whether to save the results of a cfdump to a file in text or HTML format
]]></help>
<values default="text">
<value option="html"/>
<value option="text"/>
</values>
</parameter>
<parameter name="hide" required="false" type="String">
<help><![CDATA[
hide column or keys.
]]></help>
<values/>
</parameter>
<parameter name="keys" required="false" type="Numeric">
<help><![CDATA[
For a structure, number of keys to display.
]]></help>
<values/>
</parameter>
<parameter name="label" required="false" type="String">
<help><![CDATA[
A string; header for the dump output.
]]></help>
<values/>
</parameter>
<parameter name="metainfo" required="false" type="boolean">
<help><![CDATA[
Includes information about the query in the cfdump results.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="output" required="false" type="String">
<help><![CDATA[
Where to send the results of cfdump.
]]></help>
<values default="browser">
<value option="browser"/>
<value option="console"/>
<value option="filename"/>
</values>
</parameter>
<parameter name="show" required="false" type="String">
<help><![CDATA[
show column or keys.
]]></help>
<values/>
</parameter>
<parameter name="showUDfs" required="false" type="boolean">
<help><![CDATA[
show UDFs in cfdump output.
]]></help>
<values default="true">
<value option="true"/>
<value option="false"/>
</values>
</parameter>
<parameter name="top" required="false" type="Numeric">
<help><![CDATA[
The number of rows to display.
]]></help>
<values/>
</parameter>
</function>
<function name="writeLog" returns="void" >
<help><![CDATA[
Writes a message to a log file.
]]></help>
<parameter name="text" required="true" type="String">
<help><![CDATA[
Message text to log.
]]></help>
<values/>
</parameter>
<parameter name="log" required="false" type="String">
<help><![CDATA[
If you omit the file attribute, writes messages to standard
log file. Ignored, if you specify file attribute.
Application: writes to Application.log, normally used for
application-specific messages.
Scheduler: writes to Scheduler.log, normally used to log
the execution of scheduled tasks.
]]></help>
<values>
<value option="Application"/>
<value option="Scheduler"/>
</values>
</parameter>
<parameter name="file" required="false" type="String">
<help><![CDATA[
Message file. Specify only the main part of the filename.
For example, to log to the Testing.log file, specify
"Testing".
The file must be located in the default log directory. You
cannot specify a directory path. If the file does not
exist, it is created automatically, with the suffix .log.
]]></help>
<values/>
</parameter>
<parameter name="type" required="false" type="String">
<help><![CDATA[
Type (severity) of the message
]]></help>
<values>
<value option="information"/>
<value option="warning"/>
<value option="error"/>
<value option="fatal"/>
</values>
</parameter>
<parameter name="application" required="false" type="boolean">
<help><![CDATA[
log application name, if it is specified in a cfapplication
tag.
]]></help>
<values>
<value option="true"/>
<value option="false"/>
</values>
</parameter>
</function>
<function name="verifyClient" returns="void">
<help><![CDATA[
Verifies whether request is from valid client or not
]]></help>
</function>
</functions>
<cfscopes>
<scopevar name="Client" >
<help><![CDATA[Client scope variables ]]></help>
<scopevar name="CFID" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="CFToken" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="HitCount" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="LastVisit" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="TimeCreated" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="URLToken" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="CGI" >
<help><![CDATA[ ]]></help>
<scopevar name="AUTH_PASSWORD" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="AUTH_TYPE" >
<help><![CDATA[ If the server supports user authentication, and the script is protected, the protocol-specific authentication method used to validate the user. ]]></help>
</scopevar>
<scopevar name="AUTH_USER" >
<help><![CDATA[ If the server supports user authentication, and the script is protected, the username the user has authenticated as. (Also available as AUTH_USER.) ]]></help>
</scopevar>
<scopevar name="CERT_COOKIE" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="CERT_FLAGS" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="CERT_ISSUER" >
<help><![CDATA[ Information about the authority that provided the client certificate ]]></help>
</scopevar>
<scopevar name="CERT_KEYSIZE" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="CERT_SECRETKEYSIZE" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="CERT_SERIALNUMBER" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="CERT_SERVER_ISSUER" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="CERT_SERVER_SUBJECT" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="CERT_SUBJECT" >
<help><![CDATA[ Client-specific information provided by the web server. This data typically includes the client's name, e-mail address, and so on ]]></help>
</scopevar>
<scopevar name="CF_TEMPLATE_PATH" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="CONTENT_LENGTH" >
<help><![CDATA[ Length of the content as given by the client. ]]></help>
</scopevar>
<scopevar name="CONTENT_TYPE" >
<help><![CDATA[ For queries that have attached information, such as HTTP POST and PUT, this is the content type of the data. ]]></help>
</scopevar>
<scopevar name="CONTEXT_PATH" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="GATEWAY_INTERFACE" >
<help><![CDATA[ CGI specification revision with which this server complies. Format: CGI/revision. ]]></help>
</scopevar>
<scopevar name="HTTPS" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="HTTPS_KEYSIZE" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="HTTPS_SECRETKEYSIZE" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="HTTPS_SERVER_ISSUER" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="HTTPS_SERVER_SUBJECT" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="HTTP_ACCEPT" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="HTTP_ACCEPT_ENCODING" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="HTTP_ACCEPT_LANGUAGE" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="HTTP_CONNECTION" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="HTTP_COOKIE" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="HTTP_HOST" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="HTTP_REFERER" >
<help><![CDATA[ The referring document that linked to or submitted form data. ]]></help>
</scopevar>
<scopevar name="HTTP_USER_AGENT" >
<help><![CDATA[ The browser that the client is currently using to send the request. Format: software/version library/version. ]]></help>
</scopevar>
<scopevar name="QUERY_STRING" >
<help><![CDATA[ Query information that follows the ? in the URL that referenced this script. ]]></help>
</scopevar>
<scopevar name="REMOTE_ADDR" >
<help><![CDATA[ IP address of the remote host making the request. ]]></help>
</scopevar>
<scopevar name="REMOTE_HOST" >
<help><![CDATA[ Hostname making the request. If the server does not have this information, it sets REMOTE_ADDR and does not set REMOTE_HOST. ]]></help>
</scopevar>
<scopevar name="REMOTE_USER" >
<help><![CDATA[ If the server supports user authentication, and the script is protected, the username the user has authenticated as. (Also available as AUTH_USER.) ]]></help>
</scopevar>
<scopevar name="REQUEST_METHOD" >
<help><![CDATA[ Method with which the request was made. For HTTP, this is Get, Head, Post, and so on. ]]></help>
</scopevar>
<scopevar name="SCRIPT_NAME" >
<help><![CDATA[ Virtual path to the script that is executing; used for self-referencing URLs. ]]></help>
</scopevar>
<scopevar name="SERVER_NAME" >
<help><![CDATA[ Server's hostname, DNS alias, or IP address as it appears in self-referencing URLs. ]]></help>
</scopevar>
<scopevar name="SERVER_PORT" >
<help><![CDATA[ Port number to which the request was sent. ]]></help>
</scopevar>
<scopevar name="SERVER_PORT_SECURE" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="SERVER_PROTOCOL" >
<help><![CDATA[ Name and revision of the information protocol this request came in with. Format: protocol/revision. ]]></help>
</scopevar>
<scopevar name="SERVER_SOFTWARE" >
<help><![CDATA[ Name and version of the information server software answering the request (and running the gateway). Format: name/version. ]]></help>
</scopevar>
<scopevar name="WEB_SERVER_API" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="Server" >
<help><![CDATA[Client scope variables ]]></help>
<scopevar name="ColdFusion" >
<help><![CDATA[ ]]></help>
<scopevar name="ProductName" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ProductVersion" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ProductLevel" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="SerialNumber" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="SupportedLocales" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="AppServer" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Expiration" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="RootDir" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="OS" >
<help><![CDATA[ ]]></help>
<scopevar name="Name" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="AdditionalInformation" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Version" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="BuildNumber" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
</scopevar>
<scopevar name="Application" >
<help><![CDATA[ ]]></help>
<scopevar name="ApplicationName" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="Session" >
<help><![CDATA[ ]]></help>
<scopevar name="CFID" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="CFToken" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="URLToken" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="CFFtp" >
<help><![CDATA[ ]]></help>
<scopevar name="Succeeded" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ErrorCode" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ErrorText" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ReturnValue" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="CFHttp" >
<help><![CDATA[ ]]></help>
<scopevar name="FileContent" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="MimeType" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Header" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ResponseHeader" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="StatusCode" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="CFLDAP" type="query" attribute="action" attributevalue="query" >
<help><![CDATA[ ]]></help>
<scopevar name="CurrentRow" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="RecordCount" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ColumnList" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="CFPOP" type="query" returnattribute="name" >
<help><![CDATA[ ]]></help>
<scopevar name="Date" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="From" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Body" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Header" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="MessageNumber" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ReplyTo" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Subject" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="CC" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="To" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="CurrentRow" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="RecordCount" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ColumnList" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Attachments" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="AttachmentFiles" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="CFQuery" >
<returnvar attribute="name">
<scopevar name="CurrentRow" >
<help><![CDATA[ Current row of query that cfoutput is processing. ]]></help>
</scopevar>
<scopevar name="RecordCount" >
<help><![CDATA[ Number of records (rows) returned from the query. ]]></help>
</scopevar>
<scopevar name="ColumnList" >
<help><![CDATA[ Comma-separated list of the query columns. ]]></help>
</scopevar>
</returnvar>
<scopevar name="ExecutionTime " >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="CFStoredProc" >
<scopevar name="ExecutionTime" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="StatusCode" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="CFRegistry" >
<returnvar attribute="name">
<scopevar name="Entry" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Type" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Value" >
<help><![CDATA[ ]]></help>
</scopevar>
</returnvar>
</scopevar>
<scopevar name="CFSEARCH" >
<returnvar attribute="name">
<scopevar name="URL" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Key" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Title" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Score" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Custom1" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Custom2" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Summary" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="RecordCount" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="CurrentRow" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="RecordsSearched" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ColumnList" >
<help><![CDATA[ ]]></help>
</scopevar>
</returnvar>
</scopevar>
<scopevar name="CFDirectory" >
<help><![CDATA[ ]]></help>
<returnvar attribute="name" >
<scopevar name="Name" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Size" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Type" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="DateLastModified" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Attributes" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Mode" >
<help><![CDATA[ ]]></help>
</scopevar>
</returnvar>
</scopevar>
<scopevar name="CFError" >
<help><![CDATA[ ]]></help>
<scopevar name="Diagnostics" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="MailTo" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="DateTime" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Browser" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="GeneratedContent" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="RemoteAddress" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="HTTPReferer" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Template" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="QueryString" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ValidationHeader" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="InvalidFields" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ValidationFooter" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Type" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Message" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Detail" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ErrNumber" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="NativeErrorCode" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="SQLState" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="LockName" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="LockOperation" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="MissingFileName" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="TagContext" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ErrorCode" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ExtendedInfo" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="CFFile" >
<help><![CDATA[ ]]></help>
<scopevar name="AttemptedServerFile" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ClientDirectory" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ClientFile" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ClientFileExt" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ClientFileName" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ContentSubType" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ContentType" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="DateLastAccessed" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="FileExisted" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="FileSize" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="FileWasAppended" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="FileWasOverwritten" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="FileWasRenamed" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="FileWasSaved" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="OldFileSize" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ServerDirectory" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ServerFile" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ServerFileExt" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ServerFileName" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="TimeCreated" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="TimeLastModified" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="CFCatch" >
<help><![CDATA[ ]]></help>
<scopevar name="Type" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Message" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Detail" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ErrNumber" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="NativeErrorCode" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="SQLState" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="LockName" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="LockOperation" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="MissingFileName" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="TagContext" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ErrorCode" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ExtendedInfo" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="QueryError" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="SQL" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Where" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Datasource" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Name" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="TokenText" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
<scopevar name="this" >
<help><![CDATA[ ]]></help>
<scopevar name="name" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="applicationTimeout" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="clientManagement" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="clientStorage" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="Attributes" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="customTagPaths" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="loginStorage" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="mappings" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="sessionManagement" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="sessionTimeout" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="setClientCookies" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="setDomainCookies" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="scriptProtect" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="secureJSON" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="secureJSONPrefix" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="welcomeFileList" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ormEnabled" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="ormSettings" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="datasource" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="enableRobustException" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="debuggingIPAddress" >
<help><![CDATA[ ]]></help>
</scopevar>
<scopevar name="smtpServerSettings" >
<help><![CDATA[ ]]></help>
</scopevar>
</scopevar>
</cfscopes>
<scopes>
<scopes >
<!-- Updated by Jordan Clark: [email protected] -->
<!-- Server scope variables -->
<scope type="String" value="Server.ColdFusion.ProductName">
<help><![CDATA[
ColdFusion product name, usually "ColdFusion Server"
]]></help>
</scope>
<scope type="String" value="Server.ColdFusion.ProductVersion">
<help><![CDATA[
ColdFusion product release information. Comma seperated list
of build numbers, first number is the major build number.
Example: 7,0,1,116466
]]></help>
</scope>
<scope type="String" value="Server.ColdFusion.ProductLevel">
<help><![CDATA[
ColdFusion product level information, for example:
"Professional", "Enterprise", or "Developer"
]]></help>
</scope>
<scope type="String" value="Server.ColdFusion.SerialNumber">
<help><![CDATA[
ColdFusion serial number.
]]></help>
</scope>
<scope type="String" value="Server.ColdFusion.SupportedLocales">
<help><![CDATA[
Locales supported by ColdFusion, comma seperated.
]]></help>
</scope>
<scope type="DateTime" value="Server.ColdFusion.Expiration">
<help><![CDATA[
Expiration date of ColdFusion.
]]></help>
</scope>
<scope type="String" value="Server.ColdFusion.RootDir">
<help><![CDATA[
Directory ColdFusion is installed to
Example: C:\CFusionMX7
]]></help>
</scope>
<scope type="String" value="Server.ColdFusion.AppServer">
<help><![CDATA[
Name of J2EE Application server, for stand-alone ColdFusion
the value is "JRun4".
]]></help>
</scope>
<scope type="String" value="Server.ColdFusion.InstallKit">
<help><![CDATA[
Type of installation method.
Example: Native Windows
]]></help>
</scope>
<scope type="String" value="Server.OS.Name">
<help><![CDATA[
Server operating system name.
]]></help>
</scope>
<scope type="String" value="Server.OS.AdditionalInformation">
<help><![CDATA[
Information about the host operating system.
]]></help>
</scope>
<scope type="Numeric" value="Server.OS.Version">
<help><![CDATA[
Operating system version.
]]></help>
</scope>
<scope type="String" value="Server.OS.Arch">
<help><![CDATA[
The computer architecture, Windows computers are: x86
]]></help>
</scope>
<scope type="String" value="Server.OS.BuildNumber">
<help><![CDATA[
Build number of the host operating system.
]]></help>
</scope>
<!-- Application Scope variables -->
<scope type="String" value="Application.ApplicationName">
<help><![CDATA[
Name of the application set with the cfapplication tag, or
in Application.cfc
]]></help>
</scope>
<!-- Application.CFC THIS variables -->
<!-- REFERENCE: http://livedocs.macromedia.com/coldfusion/7/htmldocs/wwhelp/wwhimpl/js/html/wwhelp.htm?href=00001134.htm#1133743 -->
<scope type="String" value="ApplicationCFC.Name">
<help><![CDATA[
The application name. If you do not set this variable, or
set it to the empty string, your CFC applies to the unnamed
application scope, which is the ColdFusion MX J2EE servlet
context.
]]></help>
</scope>
<scope type="DateTime" value="ApplicationCFC.ApplicationTimeout">
<help><![CDATA[
Life span, as a real number of days, of the application,
including all Application scope variables. Use the CFML
CreateTimeSpan function to generate this variable's value.
]]></help>
</scope>
<scope type="boolean" value="ApplicationCFC.ClientManagement">
<help><![CDATA[
Whether the application supports Client scope variables.
]]></help>
</scope>
<scope type="String" value="ApplicationCFC.ClientStorage">
<help><![CDATA[
Where Client variables are stored; can be cookie, registry,
or the name of a data source.
]]></help>
</scope>
<scope type="String" value="ApplicationCFC.LoginStorage">
<help><![CDATA[
Whether to store login information in the Cookie scope or the
Session scope.
]]></help>
</scope>
<scope type="boolean" value="ApplicationCFC.SessionManagement">
<help><![CDATA[
Whether the application supports Session scope variables.
]]></help>
</scope>
<scope type="DateTime" value="ApplicationCFC.SessionTimeout">
<help><![CDATA[
Life span, as a real number of days, of the user session,
including all Session variables. Use the CFML CreateTimeSpan
function to generate this variable's value.
]]></help>
</scope>
<scope type="boolean" value="ApplicationCFC.SetClientCookies">
<help><![CDATA[
Whether to send CFID and CFTOKEN cookies to the client
browser.
]]></help>
</scope>
<scope type="boolean" value="ApplicationCFC.SetDomainCookies">
<help><![CDATA[
Whether to set CFID and CFTOKEN cookies for a domain (not
just a host).
]]></help>
</scope>
<scope type="boolean" value="ApplicationCFC.ScriptProtect">
<help><![CDATA[
Whether to protect variables from cross-site scripting
attacks.
]]></help>
</scope>
<!-- Client scope variables -->
<!-- REFERENCE: http://livedocs.macromedia.com/coldfusion/7/htmldocs/wwhelp/wwhimpl/js/html/wwhelp.htm?href=00001134.htm#1133743 -->
<!-- REFERENCE: expressionelements.vtm -->
<scope type="Numeric" value="Client.CFID">
<help><![CDATA[
Unique client ID. Part of the session key.
]]></help>
</scope>
<scope type="Numeric" value="Client.CFToken">
<help><![CDATA[
Unique ID. Part of the session key.
]]></help>
</scope>
<scope type="Numeric" value="Client.HitCount">
<help><![CDATA[
Number of client visits.
]]></help>
</scope>
<scope type="DateTime" value="Client.LastVisit">
<help><![CDATA[
Date and time of the last visit.
]]></help>
</scope>
<scope type="DateTime" value="Client.TimeCreated">
<help><![CDATA[
Date and time of first visit.
]]></help>
</scope>
<scope type="String" value="Client.URLToken">
<help><![CDATA[
CFID combined with CFTOKEN.
Example: CFID=123&CFTOKEN=45678
]]></help>
</scope>
<!-- Session Scope variables -->
<scope type="Numeric" value="Session.CFID">
<help><![CDATA[
Unique Session ID. Part of the session key.
]]></help>
</scope>
<scope type="Numeric" value="Session.CFToken">
<help><![CDATA[
Unique Session ID. Part of the session key.
]]></help>
</scope>
<scope type="String" value="Session.URLToken">
<help><![CDATA[
CFID combined with CFTOKEN
Eexample: CFID=123&CFTOKEN=45678
]]></help>
</scope>
<scope type="String" value="Session.SessionID">
<help><![CDATA[
A unique identifier for the session. ColdFusion session
management: a combination of the application name and CFID
and CFToken values. J2EE session management: the jsessionid
value.
]]></help>
</scope>
<!-- Custom tag variables -->
<scope type="String" value="ThisTag.ExecutionMode">
<help><![CDATA[
A custom tag template may be invoked in either of two modes:
"Start" tag execution and "End" tag execution. "Inactive" is
another possible value, but for unknown purposes.
]]></help>
</scope>
<scope type="boolean" value="ThisTag.HasEndTag">
<help><![CDATA[
Used for code validation, it distinguishes between custom
tags that have and don't have end tags for
ExecutionMode='start'. The name of the Boolean value is
ThisTagHasEndTag.
]]></help>
</scope>
<scope type="String" value="ThisTag.GeneratedContent">
<help><![CDATA[
Custom tags can access and modify the generated content of
any of its instances using the ThisTag.GeneratedContent
variable.
]]></help>
</scope>
<scope type="Struct" value="ThisTag.AssocAttribs">
<help><![CDATA[
Holds the attributes of all nested tags if CFASSOCIATE has
used them.
]]></help>
</scope>
<!-- cffile action="upload" variables -->
<!-- CFFILE prefix can be renamed with RESULT attribute -->
<scope type="boolean" value="CFFILE.AttemptedServerFile">
<help><![CDATA[
Specifies whether or not ColdFusion attempted to save a file.
]]></help>
</scope>
<scope type="String" value="CFFILE.ClientDirectory">
<help><![CDATA[
Full path of the uploaded file on the clients system.
]]></help>
</scope>
<scope type="String" value="CFFILE.ClientFile">
<help><![CDATA[
Filename of the uploaded file on the clients system.
]]></help>
</scope>
<scope type="String" value="CFFILE.ClientFileExt">
<help><![CDATA[
Extension of the uploaded file on the clients system without
a period.
]]></help>
</scope>
<scope type="String" value="CFFILE.ClientFileName">
<help><![CDATA[
Filename without an extension of the uploaded file on the
client's system.
]]></help>
</scope>
<scope type="String" value="CFFILE.ContentSubType">
<help><![CDATA[
MIME content subtype of the saved file.
]]></help>
</scope>
<scope type="String" value="CFFILE.ContentType">
<help><![CDATA[
MIME content type of the saved file.
]]></help>
</scope>
<scope type="DateTime" value="CFFILE.DateLastAccessed">
<help><![CDATA[
Date and time the uploaded file was last accessed.
]]></help>
</scope>
<scope type="boolean" value="CFFILE.FileExisted">
<help><![CDATA[
Specifies whether or not the file already existed with the
same path.
]]></help>
</scope>
<scope type="Numeric" value="CFFILE.FileSize">
<help><![CDATA[
Size of the uploaded file.
]]></help>
</scope>
<scope type="boolean" value="CFFILE.FileWasAppended">
<help><![CDATA[
Specifies whether or not ColdFusion appended a file to an
existing file.
]]></help>
</scope>
<scope type="boolean" value="CFFILE.FileWasOverwritten">
<help><![CDATA[
Specifies whether or not ColdFusion overwrote a file.
]]></help>
</scope>
<scope type="boolean" value="CFFILE.FileWasRenamed">
<help><![CDATA[
Specifies whether or not the uploaded file was renamed to
avoid a name conflict.
]]></help>
</scope>
<scope type="boolean" value="CFFILE.FileWasSaved">
<help><![CDATA[
Specifies whether or not ColdFusion saved a file.
]]></help>
</scope>
<scope type="Numeric" value="CFFILE.OldFileSize">
<help><![CDATA[
Size of a file that was overwritten in the file upload
operation.
]]></help>
</scope>
<scope type="String" value="CFFILE.ServerDirectory">
<help><![CDATA[
Full path of the file actually saved.
]]></help>
</scope>
<scope type="String" value="CFFILE.ServerFile">
<help><![CDATA[
Filename of the file actually saved.
]]></help>
</scope>
<scope type="String" value="CFFILE.ServerFileExt">
<help><![CDATA[
Extension of the uploaded file on the server, without a period
Example: txt
]]></help>
</scope>
<scope type="String" value="CFFILE.ServerFileName">
<help><![CDATA[
Filename, without an extension, of the uploaded file on the
server.
]]></help>
</scope>
<scope type="DateTime" value="CFFILE.TimeCreated">
<help><![CDATA[
Time the uploaded file was created.
]]></help>
</scope>
<scope type="DateTime" value="CFFILE.TimeLastModified">
<help><![CDATA[
Date and time of the last modification to the uploaded file.
]]></help>
</scope>
<!-- CFFTP variables -->
<!-- REFERENCE: http://livedocs.macromedia.com/coldfusion/7/htmldocs/wwhelp/wwhimpl/common/html/wwhelp.htm?context=ColdFusion_Documentation&file=00000261.htm -->
<!-- REFERENCE: expressionelements.vtm -->
<!-- CFFTP prefix can be renamed with RESULT attribute -->
<scope type="String" value="CFFTP.ReturnValue">
<help><![CDATA[
The result value depending on the action performed, as
follows:
getCurrentDir = current directory (string)
getCurrentURL = current URL (string)
existsDir = yes/no
existsFile = yes/no
exists = yes/no
]]></help>
</scope>
<scope type="boolean" value="CFFTP.Succeeded">
<help><![CDATA[
Yes or No dependent on value of ErrorCode.
]]></help>
</scope>
<scope type="Numeric" value="CFFTP.ErrorCode">
<help><![CDATA[
Error code.
]]></help>
</scope>
<scope type="String" value="CFFTP.ErrorText">
<help><![CDATA[
Text associated with ErrorCode.
]]></help>
</scope>
<!-- Returned from "ListDir" action as a query with these fields -->
<!-- CFFTP prefix is set by NAME attribute -->
<scope type="String" value="CFFTPList.Name">
<help><![CDATA[
ListDir Query Field: Filename of the current element.
]]></help>
</scope>
<scope type="String" value="CFFTPList.Path">
<help><![CDATA[
ListDir Query Field: File path (without the drive
designation) of the current element.
]]></help>
</scope>
<scope type="String" value="CFFTPList.URL">
<help><![CDATA[
ListDir Query Field: Complete URL for the current element
(file or directory).
]]></help>
</scope>
<scope type="Numeric" value="CFFTPList.Length">
<help><![CDATA[
ListDir Query Field: Number indicating file size of the
current element.
]]></help>
</scope>
<scope type="DateTime" value="CFFTPList.LastModified">
<help><![CDATA[
ListDir Query Field: Unformatted date/time value of the
current element.
]]></help>
</scope>
<scope type="String" value="CFFTPList.Attributes">
<help><![CDATA[
ListDir Query Field: Indicates attributes of the current
element.
]]></help>
</scope>
<scope type="boolean" value="CFFTPList.IsDirectory">
<help><![CDATA[
ListDir Query Field: Indicates whether object is a file or
directory.
]]></help>
</scope>
<scope type="String" value="CFFTPList.CurrentRow">
<help><![CDATA[
The current row of the query in a loop.
]]></help>
</scope>
<scope type="Numeric" value="CFFTPList.RecordCount">
<help><![CDATA[
Total number of records in the query.
]]></help>
</scope>
<scope type="Numeric" value="CFFTPList.ColumnList">
<help><![CDATA[
Column list, comma seperated.
]]></help>
</scope>
<!-- CFNTAUTHENTICATE -->
<!-- CFNTAUTHENTICATE prefix is set by RESULT attribute -->
<scope type="boolean" value="CFNTAUTHENTICATE.auth">
<help><![CDATA[
Whether the user is authenticated
]]></help>
</scope>
<scope type="String" value="CFNTAUTHENTICATE.groups">
<help><![CDATA[
A comma-delimited list of the user's groups in the specified
domain. The structure includes this field only if the
listGroups attribute is Yes.
]]></help>
</scope>
<scope type="String" value="CFNTAUTHENTICATE.name">
<help><![CDATA[
The user name; equals the tag's name attribute.
]]></help>
</scope>
<scope type="String" value="CFNTAUTHENTICATE.status">
<help><![CDATA[
The authentication status. One of the following:
- success
- UserNotInDirFailure: the user is not listed in the directory.
- AuthenticationFailure: the user is in the directory, but
the password is not valid.
]]></help>
</scope>
<!-- CFDIRECTORY ACTION="LIST" QUERY -->
<!-- REFERENCE: http://livedocs.macromedia.com/coldfusion/7/htmldocs/wwhelp/wwhimpl/js/html/wwhelp.htm?href=00001134.htm#1133743 -->
<!-- REFERENCE: expressionelements.vtm -->
<!-- CFDIRECTORY prefix is set by QUERY attribute -->
<scope type="String" value="CFDIRECTORY.Attributes">
<help><![CDATA[
Returns file attributes, if applicable.
]]></help>
</scope>
<scope type="DateTime" value="CFDIRECTORY.DateLastModified">
<help><![CDATA[
Returns the date an entry was last modified.
]]></help>
</scope>
<scope type="String" value="CFDIRECTORY.Directory">
<help><![CDATA[
Directory containing the entry.
]]></help>
</scope>
<scope type="String" value="CFDIRECTORY.Mode">
<help><![CDATA[
(Deprecated) Empty value for backward compatibility with
ColdFusion 5 on UNIX.
]]></help>
</scope>
<scope type="String" value="CFDIRECTORY.Name">
<help><![CDATA[
Returns the directory or file entry name. ( "." and ".."
aren't returned since 6.0)
]]></help>
</scope>
<scope type="Numeric" value="CFDIRECTORY.Size">
<help><![CDATA[
Returns the size of directory or file entry.
]]></help>
</scope>
<scope type="String" value="CFDIRECTORY.Type">
<help><![CDATA[
Returns entry type: "File" or "Dir".
]]></help>
</scope>
<scope type="String" value="CFDIRECTORY.CurrentRow">
<help><![CDATA[
The current row of the query in a loop.
]]></help>
</scope>
<scope type="Numeric" value="CFDIRECTORY.RecordCount">
<help><![CDATA[
Total number of records in the query.
]]></help>
</scope>
<scope type="Numeric" value="CFDIRECTORY.ColumnList">
<help><![CDATA[
Column list, comma seperated.
]]></help>
</scope>
<!-- CFREGISTRY ACTION="GETALL" QUERY -->
<!-- REFERENCE: expressionelements.vtm -->
<!-- CFREGISTRY prefix is set by NAME attribute -->
<scope type="String" value="CFREGISTRY.Entry">
<help><![CDATA[
Registry value name.
]]></help>
</scope>
<scope type="String" value="CFREGISTRY.Type">
<help><![CDATA[
Data type.
]]></help>
</scope>
<scope type="String" value="CFREGISTRY.Value">
<help><![CDATA[
Registry value data.
]]></help>
</scope>
<scope type="String" value="CFREGISTRY.CurrentRow">
<help><![CDATA[
The current row of the query in a loop.
]]></help>
</scope>
<scope type="Numeric" value="CFREGISTRY.RecordCount">
<help><![CDATA[
Total number of records in the query.
]]></help>
</scope>
<scope type="Numeric" value="CFREGISTRY.ColumnList">
<help><![CDATA[
Column list, comma seperated.
]]></help>
</scope>
<!-- CFSEARCH QUERY -->
<!-- REFERENCE: http://livedocs.macromedia.com/coldfusion/7/htmldocs/wwhelp/wwhimpl/js/html/wwhelp.htm?href=00001134.htm#1133743 -->
<!-- CFSEARCH prefix is set by NAME attribute -->
<scope type="String" value="CFSEARCH.URL">
<help><![CDATA[
Value of URLpath attribute in the cfindex tag used to
populate a collection.
]]></help>
</scope>
<scope type="String" value="CFSEARCH.Key">
<help><![CDATA[
Value of the key attribute in the cfindex tag used to
populate a collection.
]]></help>
</scope>
<scope type="String" value="CFSEARCH.Title">
<help><![CDATA[
Value of title attribute in cfindex tag used to populate the
collection, including PDF and Office document titles. If a
title is not extracted from the document, the tag uses the
cfindex title attribute value for each row.
]]></help>
</scope>
<scope type="Numeric" value="CFSEARCH.Score">
<help><![CDATA[
Relevancy score of document based on search criteria, from
0-1. Example: 0.92 (would be 92%)
]]></help>
</scope>
<scope type="String" value="CFSEARCH.Custom1">
<help><![CDATA[
Value of custom fields in cfindex tag used to populate a
collection.
]]></help>
</scope>
<scope type="String" value="CFSEARCH.Custom2">
<help><![CDATA[
Value of custom fields in cfindex tag used to populate a
collection.
]]></help>
</scope>
<scope type="String" value="CFSEARCH.Context">
<help><![CDATA[
A context summary containing the search terms, highlighted in
bold (by default). This is enabled if you set the
contextpassages attribute to a number greater than zero.
]]></help>
</scope>
<scope type="String" value="CFSEARCH.Custom3">
<help><![CDATA[
Value of custom fields in cfindex tag used to populate a
collection.
]]></help>
</scope>
<scope type="String" value="CFSEARCH.Custom4">
<help><![CDATA[
Value of custom fields in cfindex tag used to populate a
collection.
]]></help>
</scope>
<scope type="Numeric" value="CFSEARCH.Size">
<help><![CDATA[
The number of bytes in the index document.
]]></help>
</scope>
<scope type="String" value="CFSEARCH.Rank">
<help><![CDATA[
The rank of this document in the search results.
]]></help>
</scope>
<scope type="String" value="CFSEARCH.Author">
<help><![CDATA[
Extracted from the HTML, Office, and PDF documents when
available.
]]></help>
</scope>
<scope type="String" value="CFSEARCH.Type">
<help><![CDATA[
The MIME type of the document.
Example: text/html
]]></help>
</scope>
<scope type="String" value="CFSEARCH.Category">
<help><![CDATA[
A list of the categories that were specified for this
document when it was indexed.
]]></help>
</scope>
<scope type="String" value="CFSEARCH.CategoryTree">
<help><![CDATA[
A hierarchical category tree, or serial list of categories,
that was specified for this document when it was indexed.
Only a single tree is returned.
]]></help>
</scope>
<scope type="Numeric" value="CFSEARCH.RecordsSearched">
<help><![CDATA[
Number of records searched. This is the same value for each
row in the record set. Corresponds to the searched key in the
status structure.
]]></help>
</scope>
<scope type="String" value="CFSEARCH.Summary">
<help><![CDATA[
Contents of automatic summary generated by cfindex.
]]></help>
</scope>
<scope type="String" value="CFSEARCH.CurrentRow">
<help><![CDATA[
The current row of the query in a loop.
]]></help>
</scope>
<scope type="Numeric" value="CFSEARCH.RecordCount">
<help><![CDATA[
Total number of records in the query.
]]></help>
</scope>
<scope type="Numeric" value="CFSEARCH.ColumnList">
<help><![CDATA[
Column list, comma seperated.
]]></help>
</scope>
<!-- CFCOLLECTION -->
<!-- REFERENCE: http://livedocs.macromedia.com/coldfusion/7/htmldocs/wwhelp/wwhimpl/common/html/wwhelp.htm?context=ColdFusion_Documentation&file=00000230.htm#1097667 -->
<!-- CFCOLLECTION prefix is set by NAME attribute -->
<scope type="boolean" value="CFCOLLECTION.categories">
<help><![CDATA[
Collection has category support enabled or disabled.
]]></help>
</scope>
<scope type="String" value="CFCOLLECTION.charset">
<help><![CDATA[
The character set of the collection.
]]></help>
</scope>
<scope type="DateTime" value="CFCOLLECTION.created">
<help><![CDATA[
The date and time that the collection was created.
]]></help>
</scope>
<scope type="Numeric" value="CFCOLLECTION.doccount">
<help><![CDATA[
The number of documents in this collection.
]]></help>
</scope>
<scope type="String" value="CFCOLLECTION.external">
<help><![CDATA[
- yes: the collection is external.
- no: the collection is not external.
- Not Found: the collection is registered but is not available in the defined path .
]]></help>
</scope>
<scope type="String" value="CFCOLLECTION.language">
<help><![CDATA[
The locale setting of the collection.
(This information is not available for K2Server collections.)
]]></help>
</scope>
<scope type="DateTime" value="CFCOLLECTION.lastmodified">
<help><![CDATA[
The date and time that the collection was last changed.
]]></help>
</scope>
<scope type="String" value="CFCOLLECTION.name">
<help><![CDATA[
The name of the collection.
]]></help>
</scope>
<scope type="String" value="CFCOLLECTION.path">
<help><![CDATA[
Absolute path to the collection.
]]></help>
</scope>
<scope type="Numeric" value="CFCOLLECTION.size">
<help><![CDATA[
The size of the collection, expressed in kilobytes.
]]></help>
</scope>
<scope compatibility="obsolete" type="boolean" value="CFCOLLECTION.mapped">
<help><![CDATA[
Obsolete.
The collection is mapped.
(This information is not available for K2Server collections.)
]]></help>
</scope>
<scope compatibility="obsolete" type="boolean" value="CFCOLLECTION.online">
<help><![CDATA[
Obsolete.
The collection can be searched.
(If EXTERNAL = "Not Found", this value is "No".)
]]></help>
</scope>
<scope compatibility="obsolete" type="String" value="CFCOLLECTION.registered">
<help><![CDATA[
Obsolete.
- CF: collection is registered by ColdFusion
- K2: collection is registered by K2Server
]]></help>
</scope>
<!-- CFSTOREDPROC -->
<!-- REFERENCE: http://livedocs.macromedia.com/coldfusion/7/htmldocs/wwhelp/wwhimpl/js/html/wwhelp.htm?href=00001134.htm#1133743 -->
<!-- CFSTOREDPROC prefix can be renamed with RESULT attribute -->
<scope type="String" value="CFSTOREDPROC.StatusCode">
<help><![CDATA[
Status code for the stored procedure.
(only when returnCode="true")
]]></help>
</scope>
<scope type="Numeric" value="CFSTOREDPROC.ExecutionTime">
<help><![CDATA[
Execution time for the request in milliseconds.
(only when returnCode="true")
]]></help>
</scope>
<!-- CFPOP action="GETALL" and action="GETHEADERONLY" QUERY -->
<!-- REFERENCE: http://livedocs.macromedia.com/coldfusion/7/htmldocs/wwhelp/wwhimpl/js/html/wwhelp.htm?href=00001134.htm#1133743 -->
<!-- CFPOP prefix is set by NAME attribute -->
<scope type="String" value="CFPOP.Attachments">
<help><![CDATA[
Contains a tab-separated list of all original attachment
names.
(only when action="getall")
]]></help>
</scope>
<scope type="String" value="CFPOP.AttachmentFiles">
<help><![CDATA[
Contains a tab-separated list of the actual temporary
filenames written to the server.
(only when action="getall")
]]></help>
</scope>
<scope type="String" value="CFPOP.Body">
<help><![CDATA[
Body of message.
(only when action="getall")
]]></help>
</scope>
<scope type="String" value="CFPOP.TextBody">
<help><![CDATA[
Text Body of message.
(only when action="getall")
]]></help>
</scope>
<scope type="String" value="CFPOP.HtmlBody">
<help><![CDATA[
HTML Body of message.
(only when action="getall")
]]></help>
</scope>
<scope type="String" value="CFPOP.CC">
<help><![CDATA[
CC value from message header.
]]></help>
</scope>
<scope type="DateTime" value="CFPOP.Date">
<help><![CDATA[
Date sent value from message header.
]]></help>
</scope>
<scope type="String" value="CFPOP.From">
<help><![CDATA[
From value from message header.
]]></help>
</scope>
<scope type="String" value="CFPOP.Header">
<help><![CDATA[
Entire message header.
(only when action="getall")
]]></help>
</scope>
<scope type="String" value="CFPOP.MessageNumber">
<help><![CDATA[
Sequential message number of message on POP server.
]]></help>
</scope>
<scope type="String" value="CFPOP.MessageID">
<help><![CDATA[
The mail header Message-ID field.
]]></help>
</scope>
<scope type="String" value="CFPOP.ReplyTo">
<help><![CDATA[
ReplyTo value from message header.
]]></help>
</scope>
<scope type="String" value="CFPOP.Subject">
<help><![CDATA[
Subject value from message header.
]]></help>
</scope>
<scope type="String" value="CFPOP.To">
<help><![CDATA[
To value from message header.
]]></help>
</scope>
<scope type="String" value="CFPOP.ColumnList">
<help><![CDATA[
Column list, comma seperated.
]]></help>
</scope>
<scope type="Numeric" value="CFPOP.CurrentRow">
<help><![CDATA[
The current row of the query in a loop.
]]></help>
</scope>
<scope type="Numeric" value="CFPOP.RecordCount">
<help><![CDATA[
Total number of records in the query.
]]></help>
</scope>
<scope type="Numeric" value="CFPOP.UID">
<help><![CDATA[
Unique identifier for the e-mail message file.
(mail header X-UID field)
]]></help>
</scope>
<scope type="Struct" value="CFPOP.CIDS">
<help><![CDATA[
Structure that contains key-value pairs. The keys are the
names of image files that are embedded in the e-mail
message; the values are their cids. You can use the cid
to find the correct place of an image in an HTML e-mail
message that the cfpop tag retrieves. If the e-mail message
contains more than one embedded image, only the last
embedded image is available.
]]></help>
</scope>
<!-- CFQUERY Query -->
<!-- REFERENCE: http://livedocs.macromedia.com/coldfusion/7/htmldocs/wwhelp/wwhimpl/js/html/wwhelp.htm?href=00001134.htm#1133743 -->
<!-- CFQUERY prefix is set by RESULT attribute -->
<scope type="String" value="CFQUERY.SQL">
<help><![CDATA[
The SQL statement that was executed.
]]></help>
</scope>
<scope type="boolean" value="CFQUERY.Cached">
<help><![CDATA[
If the query was cached.
]]></help>
</scope>
<scope type="Array" value="CFQUERY.SqlParameters">
<help><![CDATA[
An ordered Array of cfqueryparam values.
]]></help>
</scope>
<scope type="Numeric" value="CFQUERY.RecordCount">
<help><![CDATA[
Total number of records in the query.
]]></help>
</scope>
<scope type="Numeric" value="CFQUERY.ColumnList">
<help><![CDATA[
Column list, comma seperated.
]]></help>
</scope>
<scope type="Numeric" value="CFQUERY.ExecutionTime">
<help><![CDATA[
Execution time for the SQL request.
]]></help>
</scope>
<!-- Any Query -->
<scope type="String" value="QUERY.CurrentRow">
<help><![CDATA[
The current row of the query in a loop.
]]></help>
</scope>
<scope type="Numeric" value="QUERY.RecordCount">
<help><![CDATA[
Total number of records in the query.
]]></help>
</scope>
<scope type="Numeric" value="QUERY.ColumnList">
<help><![CDATA[
Column list, comma seperated.
]]></help>
</scope>
<!-- cfhttp variables -->
<!-- CFHTTP prefix can be renamed with RESULT attribute -->
<!-- REFERENCE: http://livedocs.macromedia.com/coldfusion/7/htmldocs/wwhelp/wwhimpl/common/html/wwhelp.htm?context=ColdFusion_Documentation&file=00000272.htm -->
<scope type="String" value="CFHTTP.CharSet">
<help><![CDATA[
Response character character set (character encoding)
specified by the response Content-Type header.
]]></help>
</scope>
<scope type="String" value="CFHTTP.ErrorDetail">
<help><![CDATA[
If the connection to the HTTP server fails, contains details
about the failure. For instance: "Unknown host: my.co.com";
otherwise, the empty string. Macromedia recommends that you
check this variable for an error condition before checking
other variables.
]]></help>
</scope>
<scope type="String" value="CFHTTP.FileContent">
<help><![CDATA[
Response body; for example: the contents of a html page
retrieved by a GET operation. Empty if you save the response
in a file.
]]></help>
</scope>
<scope type="String" value="CFHTTP.Header">
<help><![CDATA[
Raw response header containing all header information in a
single string. Contains the same information as the
#cfhttp.responseHeader# variable.
]]></help>
</scope>
<scope type="String" value="CFHTTP.MimeType">
<help><![CDATA[
MIME type specified by the response Content-Type header,
Example: text/html
]]></help>
</scope>
<scope type="String" value="CFHTTP.ResponseHeader">
<help><![CDATA[
The response headers formatted into a structure. Each element
key is the header name, such as Content-Type or Status_Code.
If there is more than one instance of a header type, the type
values are put in an array. One common technique is to
dynamically access the cfhttp.responseHeader structure as a
dynamic array, example: #cfhttp.resonseHeader[fieldVariable]#
]]></help>
</scope>
<scope type="String" value="CFHTTP.StatusCode">
<help><![CDATA[
The HTTP status_code header value followed by the HTTP
Explanation header value.
Example: 200 OK
]]></help>
</scope>
<scope type="boolean" value="CFHTTP.Text">
<help><![CDATA[
Boolean; True if the response body content type is text.
ColdFusion recognizes the response body as text if: The
header does not specify a content type, or it starts with
"text" or "message" or the full content
type="application/octet-stream".
]]></help>
</scope>
<!-- CGI scope variables -->
<!-- REFERENCE: Apache: http://www.zytrax.com/tech/web/env_var.htm -->
<!-- REFERENCE: IIS: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/iissdk/html/21b3be8f-d4ed-4059-8e21-6cba2c253006.asp -->
<!-- REFERENCE: Zeus: http://www.zeus.com/extra/docsystem/docroot/apps/web/docs/modules/cgi/reference.html -->
<scope type="String" value="CGI.ALL_HTTP">
<help><![CDATA[
All HTTP headers that were not already parsed into one of the
listed variables. These variables are of the form HTTP_header
field name with each variable separated by a semi-colon
]]></help>
</scope>
<scope type="String" value="CGI.ALL_RAW">
<help><![CDATA[
(IIS) Retrieves all headers in raw form. The difference
between CGI.ALL_RAW and CGI.ALL_HTTP is that CGI.ALL_HTTP
places an HTTP_ prefix before the header name and the header
name is always capitalized. In ALL_RAW the header name and
values appear as they are sent by the client.
]]></help>
</scope>
<scope type="String" value="CGI.APP_POOL_ID">
<help><![CDATA[
(IIS) Returns the name of the application pool that is
running in the IIS worker process that is handling the
request. There is also an CGI.APP_POOL_ID environment
variable that is available to applications that are running
in the IIS worker process. (Note: IIS 5.1 and earlier: This server
variable is not available.)
]]></help>
</scope>
<scope type="String" value="CGI.APPL_MD_PATH">
<help><![CDATA[
(IIS) Retrieves the metabase path of the application.
]]></help>
</scope>
<scope type="String" value="CGI.APPL_PHYSICAL_PATH">
<help><![CDATA[
(IIS) Retrieves the physical path corresponding to the
metabase path in CGI.APPL_MD_PATH.
]]></help>
</scope>
<scope type="String" value="CGI.AUTH_PASSWORD">
<help><![CDATA[
(IIS) The value entered in the client's authentication
dialog. This variable is available only if Basic
authentication is used.
]]></help>
</scope>
<scope type="String" value="CGI.AUTH_TYPE">
<help><![CDATA[
If the server supports user authentication, and the script
is protected, this is the protocol-specific authentication
method used to validate the user.
]]></help>
</scope>
<scope type="String" value="CGI.AUTH_USER">
<help><![CDATA[
(IIS) The name of the user as it is derived from the
authorization header sent by the client, before the user
name is mapped to a Windows account. This variable is no
different from CGI.REMOTE_USER. If you have an authentication
filter installed on your Web server that maps incoming users
to accounts, use CGI.LOGON_USER to view the mapped user name.
]]></help>
</scope>
<scope type="String" value="CGI.CACHE_URL">
<help><![CDATA[
(IIS) Returns the full URL
Example: http://www.macromedia.com:80/index.cfm?query=string
(Note: IIS 5.1 and earlier: This server variable is not
available.)
]]></help>
</scope>
<scope type="String" value="CGI.CERT_COOKIE">
<help><![CDATA[
(IIS) Unique ID for the client certificate, returned as a
string. This can be used as a signature for the whole client
certificate.
]]></help>
</scope>
<scope type="String" value="CGI.CERT_FLAGS">
<help><![CDATA[
(IIS) bit0 is set to 1 if the client certificate is present.
bit1 is set to 1 if the certification authority of the client
certificate is invalid (that is, it is not in the list of
recognized certification authorities on the server). If bit
1 of CGI.CERT_FLAGS is set to 1, indicating that the
certificate is invalid, IIS version 4.0 and later will reject
the certificate.
(Note: Earlier versions of IIS will not reject the
certificate.)
]]></help>
</scope>
<scope type="String" value="CGI.CERT_ISSUER">
<help><![CDATA[
Issuer field of the client certificate
(O=MS, OU=IAS, CN=user name, C=USA).
]]></help>
</scope>
<scope type="String" value="CGI.CERT_KEYSIZE">
<help><![CDATA[
(IIS) Number of bits in the Secure Sockets Layer (SSL)
connection key size.
Example: 128
]]></help>
</scope>
<scope type="String" value="CGI.CERT_SECRETKEYSIZE">
<help><![CDATA[
(IIS) Number of bits in server certificate private key.
Example: 1024
]]></help>
</scope>
<scope type="String" value="CGI.CERT_SERIALNUMBER">
<help><![CDATA[
(IIS) Serial number field of the client certificate.
]]></help>
</scope>
<scope type="String" value="CGI.CERT_SERVER_ISSUER">
<help><![CDATA[
(IIS) Issuer field of the server certificate.
]]></help>
</scope>
<scope type="String" value="CGI.CERT_SERVER_SUBJECT">
<help><![CDATA[
(IIS) Subject field of the server certificate.
]]></help>
</scope>
<scope type="String" value="CGI.CERT_SUBJECT">
<help><![CDATA[
Subject field of the client certificate.
]]></help>
</scope>
<scope type="String" value="CGI.CF_TEMPLATE_PATH">
<help><![CDATA[
Show the entire file path to the coldfusion template, similar
to CGI.PATH_TRANSLATED.
Example: c:\inetpub\wwwroot\somesite\somepage.cfm
]]></help>
</scope>
<scope type="String" value="CGI.CLIENT_CERT_ENCODED">
<help/>
</scope>
<scope type="String" value="CGI.CONTENT_LENGTH">
<help><![CDATA[
The length of the content as given by the client.
]]></help>
</scope>
<scope type="String" value="CGI.CONTENT_TYPE">
<help><![CDATA[
For queries that have attached information, such as HTTP POST
and PUT, this is the content type of the data.
]]></help>
</scope>
<scope type="String" value="CGI.DATE_GMT">
<help><![CDATA[
(Apache SSI) The current date and time in Greenwich Mean Time
(now Unviversal Co-ordinated Time (UCT) in the default or
#config defined format). Thursday, 03-May-2001 21:18:54 GMT
]]></help>
</scope>
<scope type="String" value="CGI.DATE_LOCAL">
<help><![CDATA[
(Apache SSI) The current date and time in the local (server)
timezone (in the default or #config defined format),
Example: Thursday, 03-May-2001 17:18:54 EDT
]]></help>
</scope>
<scope type="String" value="CGI.DOCUMENT_ARGS">
<help><![CDATA[
(Zeus SSI) This will be set to the CGI.QUERY_STRING of the
master document. The value of CGI.QUERY_STRING for an SSI
sub-request will contain the query string in the sub-request
URL, if present, else the master document's CGI.QUERY_STRING.
]]></help>
</scope>
<scope type="String" value="CGI.DOCUMENT_NAME">
<help><![CDATA[
(Apache SSI) The file name (excludes directories) of the
document requested by the user.
Example: ssi.htm
]]></help>
</scope>
<scope type="String" value="CGI.DOCUMENT_PATH_INFO">
<help><![CDATA[
(Apache SSI/Zeus SSI) This will be set to the CGI.PATH_INFO of
the master document.
]]></help>
</scope>
<scope type="String" value="CGI.DOCUMENT_ROOT">
<help><![CDATA[
(Apache SSI) The root directory of this site defined by the
'DocumentRoot' directive in the General Section or a
<virtualhost> section.
Example: /var/www/zytrax
]]></help>
</scope>
<scope type="String" value="CGI.DOCUMENT_URI">
<help><![CDATA[
(Apache SSI/Zeus SSI) The URL path of the document requested
by the user.
Example: /tech/web/ssi.htm
]]></help>
</scope>
<scope type="String" value="CGI.GATEWAY_INTERFACE">
<help><![CDATA[
The revision of the CGI specification to which this server
complies. Format: CGI/revision.
]]></help>
</scope>
<scope type="String" value="CGI.HTTP_ACCEPT">
<help><![CDATA[
List of Content-types the browser can accept (defined by the
HTTP Accept header).
]]></help>
</scope>
<scope type="String" value="CGI.HTTP_ACCEPT_ENCODING">
<help><![CDATA[
(IIS) Returns a list of accepted encoding types.
Example: gzip, deflate
]]></help>
</scope>
<scope type="String" value="CGI.HTTP_ACCEPT_LANGUAGE">
<help><![CDATA[
(IIS) Returns a string describing the language to use for
displaying content.
]]></help>
</scope>
<scope type="String" value="CGI.HTTP_CONNECTION">
<help><![CDATA[
(IIS) Returns a string describing the connection type.
Example: Keep-Alive
]]></help>
</scope>
<scope type="String" value="CGI.HTTP_COOKIE">
<help><![CDATA[
(IIS) Returns the cookie string that was included with the
request.
]]></help>
</scope>
<scope type="String" value="CGI.HTTP_HOST">
<help><![CDATA[
(IIS) Returns the name of the Web server. This may or may
not be the same as CGI.SERVER_NAME depending on type of name
resolution you are using on your Web server (IP address,
host header).
]]></help>
</scope>
<scope type="String" value="CGI.HTTP_IF_MODIFIED_SINCE">
<help/>
</scope>
<scope type="String" value="CGI.HTTP_METHOD">
<help><![CDATA[
(IIS) The method used to make the request
(Note: same as CGI.REQUEST_METHOD).
]]></help>
</scope>
<scope type="String" value="CGI.HTTP_REFERER">
<help><![CDATA[
The referring document. The document that linked to or
submitted form data.
]]></help>
</scope>
<scope type="String" value="CGI.HTTP_URL">
<help><![CDATA[
(IIS) Returns the raw, encoded URL.
Example: /vdir/default.asp?querystring
]]></help>
</scope>
<scope type="String" value="CGI.HTTP_USER_AGENT">
<help><![CDATA[
The browser the client is currently using to send the
request. Format: software/version library/version.
]]></help>
</scope>
<scope type="String" value="CGI.HTTP_VERSION">
<help><![CDATA[
(IIS) The name and version of the request protocol (the raw
form of CGI.SERVER_PROTOCOL).
]]></help>
</scope>
<scope type="String" value="CGI.HTTPS">
<help><![CDATA[
(IIS/Zeus) Returns ON if the request came in through a secure
channel; or it returns OFF, if the request is for an
insecure channel.
Example: SSL
]]></help>
</scope>
<scope type="String" value="CGI.HTTPS_KEYSIZE">
<help><![CDATA[
(IIS/Zeus) Number of bits in the SSL connection key size.
Example: 128
]]></help>
</scope>
<scope type="String" value="CGI.HTTPS_SECRETKEYSIZE">
<help><![CDATA[
(IIS/Zeus) Number of bits in the server certificate private
key.
Example: 1024
]]></help>
</scope>
<scope type="String" value="CGI.HTTPS_SERVER_ISSUER">
<help><![CDATA[
(IIS) Issuer field of the server certificate.
]]></help>
</scope>
<scope type="String" value="CGI.HTTPS_SERVER_SUBJECT">
<help><![CDATA[
(IIS) Subject field of the server certificate.
]]></help>
</scope>
<scope type="String" value="CGI.HTTPS_SESSIONID">
<help><![CDATA[
(Zeus SSI) The value of the session id used by the SSL
session. This value is unique for each distinct SSL session
]]></help>
</scope>
<scope type="String" value="CGI.INSTANCE_ID">
<help><![CDATA[
(IIS) The ID for the IIS instance in textual format. If the
instance ID is 1, it appears as a string. You can use this
variable to retrieve the ID of the Web server instance (in
the metabase) to which the request belongs.
]]></help>
</scope>
<scope type="String" value="CGI.INSTANCE_META_PATH">
<help><![CDATA[
(IIS) The metabase path for the instance of IIS that responds
to the request.
]]></help>
</scope>
<scope type="String" value="CGI.LAST_MODIFIED">
<help><![CDATA[
(Apache SSI) The last modification date of the document (file)
requested by the user (in the default or #config defined
format). This variable related to the file currently being
accessed i.e. if you put this is an included 'footer' file
is is the modification date of the footer NOT the base
document (you need to use a simple 'wheeze' to pass a USER
variable which contains the calling documents modification
date (see here).
Example: Thursday, 03-May-2001 17:18:45 EDT
]]></help>
</scope>
<scope type="String" value="CGI.LOCAL_ADDR">
<help><![CDATA[
(IIS) Returns the server address on which the request came
in. This is important on computers where there can be
multiple IP addresses bound to the computer, and you want to
find out which address the request used.
]]></help>
</scope>
<scope type="String" value="CGI.LOGON_USER">
<help><![CDATA[
(IIS) The Windows account that the user is impersonating
while connected to your Web server. Use CGI.REMOTE_USER,
CGI.UNMAPPED_REMOTE_USER, or CGI.AUTH_USER to view the raw
user name that is contained in the request header. The only
time CGI.LOGON_USER holds a different value than these other
variables is if you have an authentication filter installed.
]]></help>
</scope>
<scope type="String" value="CGI.PATH">
<help><![CDATA[
(Apache) The PATH(s) available to the server for this web site
Example: /sbin:/usr/sbin:/bin:/usr/bin:/usr/X11R6/bin
]]></help>
</scope>
<scope type="String" value="CGI.PATH_INFO">
<help><![CDATA[
The extra path information, as given by the client. In other
words, scripts can be accessed by their virtual pathname,
followed by extra information at the end of this path. The
extra information is sent as CGI.PATH_INFO.
]]></help>
</scope>
<scope type="String" value="CGI.PATH_TRANSLATED">
<help><![CDATA[
The server provides a translated version of CGI.PATH_INFO,
which takes the path and does any virtual-to-physical mapping
to it.
]]></help>
</scope>
<scope type="String" value="CGI.QUERY_STRING">
<help><![CDATA[
The query information that follows the ? in the URL that
referenced this script.
]]></help>
</scope>
<scope type="String" value="CGI.REMOTE_ADDR">
<help><![CDATA[
The IP address of the remote host making the request.
]]></help>
</scope>
<scope type="String" value="CGI.REMOTE_HOST">
<help><![CDATA[
The hostname making the request. If the server does not have
this information, it sets CGI.REMOTE_ADDR and leaves this
unset.
]]></help>
</scope>
<scope type="String" value="CGI.REMOTE_IDENT">
<help><![CDATA[
If the HTTP server supports RFC 931 identification, then this
variable is set to the remote user name retrieved from the
server. Usage of this variable should be limited to logging
only.
]]></help>
</scope>
<scope type="String" value="CGI.REMOTE_PORT">
<help><![CDATA[
(IIS) The client port number of the TCP connection.
]]></help>
</scope>
<scope type="String" value="CGI.REMOTE_USER">
<help><![CDATA[
If the server supports user authentication, and the script is
protected, this is the username they have authenticated as.
(Also available as CGI.AUTH_USER.)
]]></help>
</scope>
<scope type="String" value="CGI.REQUEST_BODY">
<help><![CDATA[
The entity body (if any) sent with an HTTP request or
response is in a format and encoding defined by the
Entity-Header fields. See the HTTP protocol specification
for details.
]]></help>
</scope>
<scope type="String" value="CGI.REQUEST_METHOD">
<help><![CDATA[
The method with which the request was made. For HTTP, this
"GET", "HEAD", "POST", etc.
]]></help>
</scope>
<scope type="String" value="CGI.REQUEST_URI">
<help><![CDATA[
(Apache) The URI for this request (relative to
CGI.DOCUMENT_ROOT)
Example: /tech/web/ssi.htm
]]></help>
</scope>
<scope type="String" value="CGI.SCRIPT_FILENAME">
<help><![CDATA[
(Apache) The path to the script being executed (relative to
CGI.DOCUMENT_ROOT)
Example: /tech/web/ssi.htm
]]></help>
</scope>
<scope type="String" value="CGI.SCRIPT_NAME">
<help><![CDATA[
A virtual path to the script being executed, used for
self-referencing URLs.
]]></help>
</scope>
<scope type="String" value="CGI.SCRIPT_TRANSLATED">
<help><![CDATA[
(IIS) The canonical physical path to the script listed in
CGI.SCRIPT_NAME
Example: \\?\c:\inetpub\wwwroot\vdir\default.asp
(Note: IIS 5.1 and earlier: This server variable is not
available.)
]]></help>
</scope>
<scope type="String" value="CGI.SERVER_ADMIN">
<help><![CDATA[
(Apache) The administrators e-mail address for this
CGI.SERVER_NAME.
Example: [email protected]
]]></help>
</scope>
<scope type="String" value="CGI.SERVER_NAME">
<help><![CDATA[
The servers hostname, DNS alias, or IP address as it appears
in self-referencing URLs.
]]></help>
</scope>
<scope type="String" value="CGI.SERVER_PORT">
<help><![CDATA[
The port number to which the request was sent.
]]></help>
</scope>
<scope type="String" value="CGI.SERVER_PORT_SECURE">
<help><![CDATA[
(IIS) A string that contains either 0 or 1. If the request is
being handled on the secure port, then this is 1. Otherwise,
it is 0.
]]></help>
</scope>
<scope type="String" value="CGI.SERVER_PROTOCOL">
<help><![CDATA[
The name and revision of the information protocol this
request came in with. Format: protocol/revision.
]]></help>
</scope>
<scope type="String" value="CGI.SERVER_SIGNATURE">
<help><![CDATA[
(Apache) The HTML string that may be embedded in the page to
identify this host.
Example: <address>Apache/1.3.14 Server at www.zytrax.com Port
80</address>
]]></help>
</scope>
<scope type="String" value="CGI.SERVER_SOFTWARE">
<help><![CDATA[
The name and version of the information server software
answering the request (and running the gateway).
Format: name/version.
]]></help>
</scope>
<scope type="String" value="CGI.SSI_EXEC_DISABLED">
<help><![CDATA[
(IIS) Returns a 1 if the server-side include directive,
#exec, is disabled. Otherwise, CGI.SSI_EXE_DISABLED returns a
0. To enable or disable #exec, use the SSIExecDisablemetabase
property. (Note: IIS 5.1 and earlier: This server variable is
not available.)
]]></help>
</scope>
<scope type="String" value="CGI.UNENCODED_URL">
<help><![CDATA[
(IIS) Returns the raw, unencoded URL
Example: /vdir/default.asp?querystring
(Note: IIS 4.0 and earlier: This server variable is not
available)
]]></help>
</scope>
<scope type="String" value="CGI.UNMAPPED_REMOTE_USER">
<help><![CDATA[
(IIS) The name of the user as it is derived from the
authorization header sent by the client, before the user name
is mapped to a Windows account (same as CGI.REMOTE_USER). If
you have an authentication filter installed on your Web server
that maps incoming users to accounts, use CGI.LOGON_USER to
view the mapped user name.
]]></help>
</scope>
<scope type="String" value="CGI.URL">
<help><![CDATA[
(IIS) Gives the base portion of the URL, without any
querystring or extra path information. For the raw URL, use
CGI.HTTP_URL or CGI.UNENCODED_URL.
Example: "/vdir/default.asp".
]]></help>
</scope>
<scope type="String" value="CGI.URL_PATH_INFO">
<help><![CDATA[
(IIS) Use CGI.PATH_INFO instead. (Note: This server variable
is only available on IIS 5.0.)
]]></help>
</scope>
<scope type="String" value="CGI.USER_NAME">
<help><![CDATA[
(Apache SSI) The user name of the web site in which this web
site runs.
Example: zytrax
]]></help>
</scope>
<!-- CFCATCH variables -->
<scope type="String" value="CFCATCH.Type">
<help><![CDATA[
The exception's type, possible values: Application, Database,
Template, Security, Object, MissingInclude, Expression, Lock,
SearchEngine or a Custom Type.
]]></help>
</scope>
<scope type="String" value="CFCATCH.Detail">
<help><![CDATA[
A detailed message from the CFML compiler. This message,
which can contain HTML formatting, can help to determine
which tag threw the exception.
]]></help>
</scope>
<scope type="String" value="CFCATCH.ErrorCode">
<help><![CDATA[
The cfthrow tag can supply a value for this code through the
errorCode attribute. For Type="Database", CFCATCH.ErrorCode
has the same value as CFCATCH.SQLState. Otherwise, the value
of CFCATCH.ErrorCode is the empty string.
]]></help>
</scope>
<scope type="String" value="CFCATCH.ExtendedInfo">
<help><![CDATA[
Custom error message information. This is returned only to
CFCATCH tags for which the type attribute is "Application" or
a custom type. Otherwise, the value of CFCATCH.ExtendedInfo
is empty.
]]></help>
</scope>
<scope type="String" value="CFCATCH.Message">
<help><![CDATA[
The exception's default diagnostic message, if one was
provided. If no diagnostic message is available, this is
empty.
]]></help>
</scope>
<scope type="Array" value="CFCATCH.TagContext">
<help><![CDATA[
Array of tag information structures.
]]></help>
</scope>
<scope compatibility="obsolete" type="Numeric" value="CFCATCH.TagContext[x].Column">
<help><![CDATA[
Obsolete (retained for backwards compatibility). Always 0.
]]></help>
</scope>
<scope type="String" value="CFCATCH.TagContext[x].ID">
<help><![CDATA[
The tag in which the exception occurred. Exceptions in
CFScript are indicated by two question marks (??). All custom
tags, including those called directly, are identified as
cfmodule.
]]></help>
</scope>
<scope type="Numeric" value="CFCATCH.TagContext[x].Line">
<help><![CDATA[
The line on the page in which the tag is located.
]]></help>
</scope>
<scope type="String" value="CFCATCH.TagContext[x].Raw_Trace">
<help><![CDATA[
The raw Java stack trace for the error.
]]></help>
</scope>
<scope type="String" value="CFCATCH.TagContext[x].Template">
<help><![CDATA[
The pathname of the application page that contains the tag.
]]></help>
</scope>
<scope type="String" value="CFCATCH.TagContext[x].Type">
<help><![CDATA[
The type of page; it is always a ColdFusion page.
]]></help>
</scope>
<!-- expression exceptions -->
<scope type="String" value="CFCATCH.ErrNumber">
<help><![CDATA[
An internal expression error number.
Available for expression exceptions.
]]></help>
</scope>
<!-- locking exceptions -->
<scope type="String" value="CFCATCH.LockName">
<help><![CDATA[
The name of the affected lock. This is set to "anonymous" if
the lock name is unknown.
Available for locking exceptions.
]]></help>
</scope>
<scope type="String" value="CFCATCH.LockOperation">
<help><![CDATA[
The operation that failed. This is set to "unknown" if the
failed operation is unknown.
Available for locking exceptions.
]]></help>
</scope>
<!-- Missing include exceptions -->
<scope type="String" value="CFCATCH.MissingFileName">
<help><![CDATA[
The name of the missing file.
Available for missingInclude exceptions.
]]></help>
</scope>
<!-- Database exceptions -->
<scope type="String" value="CFCATCH.NativeErrorCode">
<help><![CDATA[
The native error code associated with this exception.
Database drivers typically provide error codes to assist in
the diagnosis of failing database operations. The values
assumed by CFCATCH.NativeErrorCode are driver-dependent. If
no error code is provided, the value of
CFCATCH.nativeErrorCode is -1. The value is 0 for queries of
queries.
Available for database exceptions.
]]></help>
</scope>
<scope type="String" value="CFCATCH.SQLState">
<help><![CDATA[
The SQLState code associated with this exception. Database
drivers typically provide error codes to assist in the
diagnosis of failing database operations. SQLState codes are
more consistent across database systems than native error
codes. If the driver does not provide an SQLState value, the
value of CFCATCH.SQLState is -1.
Available for database exceptions.
]]></help>
</scope>
<scope type="String" value="CFCATCH.SQL">
<help><![CDATA[
The SQL statement sent to the data source.
Available for database exceptions.
]]></help>
</scope>
<scope type="String" value="CFCATCH.QueryError">
<help><![CDATA[
The error message as reported by the database driver.
Available for database exceptions.
]]></help>
</scope>
<scope type="String" value="CFCATCH.Where">
<help><![CDATA[
If the query uses the cfqueryparam tag, query parameter
name-value pairs.
Available for database exceptions.
]]></help>
</scope>
<!-- CFERROR variables -->
<!-- REFERENCE: http://livedocs.macromedia.com/coldfusion/7/htmldocs/wwhelp/wwhimpl/common/html/wwhelp.htm?context=ColdFusion_Documentation&file=00001138.htm -->
<!-- Type: Validation -->
<scope type="String" value="CFERROR.InvalidFields">
<help><![CDATA[
Unordered list of validation errors that occurred. This
includes any text that you specify in the value attribute
or a hidden tag used to validate form input.
Available for Validation type errors.
]]></help>
</scope>
<scope type="String" value="CFERROR.ValidationHeader">
<help><![CDATA[
Text for the header of the default validation message.
Available for Validation type errors.
]]></help>
</scope>
<scope type="String" value="CFERROR.ValidationFooter">
<help><![CDATA[
Text for the footer of the default validation message.
Available for Validation type errors.
]]></help>
</scope>
<!-- Exception and Request -->
<scope type="String" value="CFERROR.Browser">
<help><![CDATA[
Browser that was running when the error occurred.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="DateTime" value="CFERROR.DateTime">
<help><![CDATA[
Date and time when the error occurred.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="String" value="CFERROR.Diagnostics">
<help><![CDATA[
Detailed error diagnostics.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="String" value="CFERROR.GeneratedContent">
<help><![CDATA[
Any content that ColdFusion generated in response to the
request prior to the error.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="String" value="CFERROR.HTTPReferer">
<help><![CDATA[
Page containing the HTML link to the page on which the error
occurred. This value is an empty string if the user specified
the page directly in the browser. (string).
Available for Exception and Request type errors
]]></help>
</scope>
<scope type="String" value="CFERROR.MailTo">
<help><![CDATA[
E-mail address of the administrator who should be notified.
This value is set in the mailTo attribute of the cferror
tag.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="String" value="CFERROR.QueryString">
<help><![CDATA[
URL query string of the client's request, if any.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="String" value="CFERROR.RemoteAddress">
<help><![CDATA[
IP address of the remote client.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="String" value="CFERROR.Template">
<help><![CDATA[
Page being executed when the error occurred.
Available for Exception and Request type errors.
]]></help>
</scope>
<!-- Exception Only -->
<scope type="String" value="CFERROR.Message">
<help><![CDATA[
Error message associated with the exception.
Available for Exception type errors.
]]></help>
</scope>
<scope type="java object" value="CFERROR.RootCause">
<help><![CDATA[
Java servlet exception reported by the JVM as the cause of
the "root cause" of the exception.
Available for Exception type errors.
]]></help>
</scope>
<scope type="String" value="CFERROR.Type">
<help><![CDATA[
Exception type, possible values: Application, Database,
Template, Security, Object, MissingInclude, Expression, Lock,
SearchEngine or a Custom Type.
]]></help>
</scope>
<scope type="Array" value="CFERROR.TagContext">
<help><![CDATA[
Array of structures containing information for each tag in
the tag stack The tag stack consists of each tag that is
currently open.
Available for Exception type errors.
]]></help>
</scope>
<scope compatibility="obsolete" type="Numeric" value="CFERROR.TagContext[x].Column">
<help><![CDATA[
Obsolete (retained for backwards compatibility). Always 0.
]]></help>
</scope>
<scope type="String" value="CFERROR.TagContext[x].ID">
<help><![CDATA[
The tag in which the exception occurred. Exceptions in CFScript
are indicated by two question marks (??). All custom tags,
including those called directly, are identified as cfmodule.
]]></help>
</scope>
<scope type="Numeric" value="CFERROR.TagContext[x].Line">
<help><![CDATA[
The line on the page in which the tag is located. (int)
]]></help>
</scope>
<scope type="String" value="CFERROR.TagContext[x].Raw_Trace">
<help><![CDATA[
The raw Java stack trace for the error.
]]></help>
</scope>
<scope type="String" value="CFERROR.TagContext[x].Template">
<help><![CDATA[
The pathname of the application page that contains the tag.
]]></help>
</scope>
<scope type="String" value="CFERROR.TagContext[x].Type">
<help><![CDATA[
The type of page; it is always a ColdFusion page.
]]></help>
</scope>
<!-- ERROR variables -->
<!-- REFERENCE: http://livedocs.macromedia.com/coldfusion/7/htmldocs/wwhelp/wwhimpl/common/html/wwhelp.htm?context=ColdFusion_Documentation&file=00001138.htm -->
<!-- Type: Validation -->
<scope type="String" value="ERROR.InvalidFields">
<help><![CDATA[
Unordered list of validation errors that occurred. This
includes any text that you specify in the value attribute
or a hidden tag used to validate form input.
Available for Validation type errors.
]]></help>
</scope>
<scope type="String" value="ERROR.ValidationHeader">
<help><![CDATA[
Text for the header of the default validation message.
Available for Validation type errors.
]]></help>
</scope>
<scope type="String" value="ERROR.ValidationFooter">
<help><![CDATA[
Text for the footer of the default validation message.
Available for Validation type errors.
]]></help>
</scope>
<!-- Exception and Request -->
<scope type="String" value="ERROR.Browser">
<help><![CDATA[
Browser that was running when the error occurred.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="DateTime" value="ERROR.DateTime">
<help><![CDATA[
Date and time when the error occurred.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="String" value="ERROR.Diagnostics">
<help><![CDATA[
Detailed error diagnostics.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="String" value="ERROR.GeneratedContent">
<help><![CDATA[
Any content that ColdFusion generated in response to the
request prior to the error.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="String" value="ERROR.HTTPReferer">
<help><![CDATA[
Page containing the HTML link to the page on which the error
occurred. This value is an empty string if the user specified
the page directly in the browser. (string).
Available for Exception and Request type errors
]]></help>
</scope>
<scope type="String" value="ERROR.MailTo">
<help><![CDATA[
E-mail address of the administrator who should be notified.
This value is set in the mailTo attribute of the ERROR
tag.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="String" value="ERROR.QueryString">
<help><![CDATA[
URL query string of the client's request, if any.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="String" value="ERROR.RemoteAddress">
<help><![CDATA[
IP address of the remote client.
Available for Exception and Request type errors.
]]></help>
</scope>
<scope type="String" value="ERROR.Template">
<help><![CDATA[
Page being executed when the error occurred.
Available for Exception and Request type errors.
]]></help>
</scope>
<!-- Exception Only -->
<scope type="String" value="ERROR.Message">
<help><![CDATA[
Error message associated with the exception.
Available for Exception type errors.
]]></help>
</scope>
<scope type="java object" value="ERROR.RootCause">
<help><![CDATA[
Java servlet exception reported by the JVM as the cause of
the "root cause" of the exception.
Available for Exception type errors.
]]></help>
</scope>
<scope type="String" value="ERROR.Type">
<help><![CDATA[
Exception type, possible values: Application, Database,
Template, Security, Object, MissingInclude, Expression, Lock,
SearchEngine or a Custom Type.
]]></help>
</scope>
<scope type="Array" value="ERROR.TagContext">
<help><![CDATA[
Array of structures containing information for each tag in
the tag stack The tag stack consists of each tag that is
currently open.
Available for Exception type errors.
]]></help>
</scope>
<scope compatibility="obsolete" type="Numeric" value="ERROR.TagContext[x].Column">
<help><![CDATA[
Obsolete (retained for backwards compatibility). Always 0.
]]></help>
</scope>
<scope type="String" value="ERROR.TagContext[x].ID">
<help><![CDATA[
The tag in which the exception occurred. Exceptions in CFScript
are indicated by two question marks (??). All custom tags,
including those called directly, are identified as cfmodule.
]]></help>
</scope>
<scope type="Numeric" value="ERROR.TagContext[x].Line">
<help><![CDATA[
The line on the page in which the tag is located. (int)
]]></help>
</scope>
<scope type="String" value="ERROR.TagContext[x].Raw_Trace">
<help><![CDATA[
The raw Java stack trace for the error.
]]></help>
</scope>
<scope type="String" value="ERROR.TagContext[x].Template">
<help><![CDATA[
The pathname of the application page that contains the tag.
]]></help>
</scope>
<scope type="String" value="ERROR.TagContext[x].Type">
<help><![CDATA[
The type of page; it is always a ColdFusion page.
]]></help>
</scope>
</scopes>
</scopes>
</dictionary>
