cfform

<cfform
accessible = "yes|no"
action = "form action"
archive = "URL"
codeBase = "URL"
format = "HTML|Flash|XML"
height = "pixels|percent"
id = "HTML id" method = "POST|GET"
name = "name"
onError = "JavaScript function name or ActionScript code"
onLoad = "load event script" onReset = "reset event script" onSubmit = "JavaScript"
onSuccess = "JavaScript function name"
preloader = "yes|no"
preserveData = "yes|no"
scriptSrc = "path"
skin = "Flash skin|XSL skin"
style = "style specification"
timeout = "seconds"
width = "pixels|percent"
wMode = "window|transparent|opaque">

...

</cfform>

Note: You can specify this tag's attributes in an attributeCollection attribute whose value is a structure. Specify the structure name in the attributeCollection attribute and use the tag's attribute names as structure keys.

accessible

Flash

Opt

no

Specifies whether to include support screen readers in the Flash form. Screen reader support adds approximately 80 KB to the SWF file sent to the client.

action

FlashHTMLXML

Opt

See Description

Name of ColdFusion page to execute when the form is submitted for processing.
If you omit this attribute and the method is get, the form posts to the page identified by the CGI.SCRIPT_NAME variable (the requested page that resulted in displaying the form). If the method is post, the form posts to the page identified by the CGI.QUERY_STRING variables.

archive

applets in HTML and XML

Opt

/CFIDE/classes/cfapplets.jar

URL of downloadable Java classes for cfgrid, cfslider, and cftree applet controls.

codeBase

applets in HTML and XML

Opt

/CFIDE/classes/cf-j2re-win.cab

URL of downloadable JRE plug-in for Internet Explorer; used for cfgrid, cfslider, and cftree Java applet controls.

format

FlashHTMLXML

Opt

HTML

• HTML: generates an HTML form and send it to the client. cfgrid and cftree child controls can be in Flash or applet format.
• Flash: generates a Flash form and send it to the client. All controls are in Flash format.
• XML: generates 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.

height

FlashXML

Opt

100%

The height of the form. Use a number to specify pixels. In Flash, you can use a percentage value, such as "height=60%" to specify a percentage of the available width. The displayed height might be less than the specified size.
Note: The width and height attributes are required for Flash forms, if they are used inside of a table.

id

name attribute value

the HTML id of the form.

method

FlashHTML XML

Opt

post

The method the browser uses to send the form data to the server:

• post: sends the data using the HTTP post method. This method sends the data in a separate message to the server.
• get: sends the data using the HTTP get method, which puts the form field contents in the URL query string.

name

FlashHTMLXML

Opt

CFForm_n

A name for the form. 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 is assigned serially to the forms on a page.

onError

FlashHTML

Opt

For Flash format forms: 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.
For HTML format forms: Applies only to forms inside cfdiv, cflayout, cfpod, or cfwindow controls. The name of a JavaScript function that runs if an asynchronous form submission fails. For more information, see the Usage section.

onLoad

HTMLXML

Opt

JavaScript to execute when the form loads.

onReset

HTMLXML

Opt

JavaScript to execute when the user clicks a reset button.

onSubmit

FlashHTMLXML

Opt

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.

onSuccess

HTML

Opt

Applies only to forms inside cfdiv, cflayout, cfpod, or cfwindow controls. The name of a JavaScript function that runs when an asynchronous form submission succeeds. For more information see the Usage section.

preloader

Flash

Opt

yes

Specifies whether to display a progress bar when loading the Flash form.

preserveData

HTMLXML

Opt

no

When the cfform action attribute posts back to the page that contains the form, this attribute determines whether to override the control values with the submitted values.

• no: uses values specified in the control tag attributes.
• yes: uses corresponding submitted values.
  Applies to these controls:
• cfinput, cfslider, cftextinput: overrides the value attribute value.
• cfselect controls that are populated from queries: overrides the selected attribute. See cfselect.
• cftree controls: overrides the cftreeitem expand attribute. If yes, expands previously-selected elements. The cftree completePath attribute must be set to yes.
• cfgrid controls: has no effect. (This avoids confusion as to whether data has been resubmitted to the database by the control.)

scriptSrc

FlashHTMLXML

Opt

See Description

Specifies the URL, relative to the web root, of the directory that contains ColdFusion JavaScript files, including 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. When you use this attribute, the specified directory must have the same structure as the /CFIDE/scripts directory. For example, if you specify scriptsrc="/resources/myScripts", the JavaScript files used by ColdFusion AJAX features must be in the /resources/myScripts/ajax directory.
This attribute is useful if the file is not in the default location. This attribute may be required in some hosting environments and configurations that block access to the /CFIDE directory. The location is set in the ColdFusion Administrator; by default, it is /CFIDE/scripts.
Notes: If you specify this attribute, copy the CF_RunActiveContent.js file from the CFIDE/scripts directory to the specified directory.
You can have only one scriptsrc attribute on a page, including any cfajaximport tag scriptsrc}}attribute. If you have multiple {{cfform tags, you can specify the scriptsrc attribute in a cfajaximport tag and it applies to all HTML format forms.

skin

FlashXML

Opt

Flash: {{haloGreen}}
XML: default.xsl

Flash: Use a halo color to stylize the output. The skin determines the color used for highlighted and selected elements.

• haloSilver
• haloBlue
• haloGreen
• haloOrange
  XML: Specifies whether to apply an XSL skin and display the resulting HTML to the client. Can be any of the following:
• ColdFusion skin name: applies the specified skin.
• XSL file name: applies the skin located in the specified path.
• none: does not apply an XSL skin. Your CFML page must process the XML that ColdFusion saves in the variable specified by the name attribute, and display any results.
• omitted or default: uses the ColdFusion default skin.
  You can specify the following ColdFusion skins (located in the cf_webroot
  x
• basic
• basiccss
• beige
• blue
• lightgray
• red
• silver
  A filename can be any of the following:
• absolute URL
• URL relative to the web root
• absolute file path
• name of a file in the scripts folder or a subdirectory of the cf_webroot\CFIDE\scripts directory. In this case, do not specify the .xsl suffix.

style

HTML, Flash, XML

Opt

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. For detailed information on specifying Flash styles, see Creating Forms in Flash in the Developing ColdFusion Applications.

timeout

Flash

Opt

0

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. For more information, see Caching data in Flash forms in Best practices for Flash forms in the Developing ColdFusion Applications.

width

FlashXML

Opt

100%

The width of the form. Use a number to specify pixels. In Flash, you can use a percentage value, such as "width=60%" to specify a percentage of the available width.Note: The width and height attributes are required for Flash forms, if they are used inside of a table.

wMode

Flash

Opt

window

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.

Note: Attributes that are not marked as supported in XML are not handled by the skins provided with ColdFusion. They are, however, included in the generated XML as html namespace attributes to the form tag.

name

The name attribute of the control's CFML tag.

field

The internal name used by Flash for the field name (for example, _level0.field1).

value

The value in the field.

message

The message attribute of the control's CFML tag.

<cfform name="form1" format="flash" width="800" height="500"
onError="if (errors['lastName'] != undefined
){tabA.selectedIndex=0; _root.lastName.setFocus();}">