name

Required;

all

Name for form input element.

autosuggest

Optional, HTML

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 that consists 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. The bind expression must pass a cfautosuggestvalue bind parameter to represent the user input.

Valid only for cfinput type="text".

For more information, see "Using autosuggest text input fields" in the ColdFusion Developer's Guide

autosuggestBindDelay

Optional, HTML

0.5 seconds

A nonzero integer that specifies the minimum time between autosuggest bind expression invocations, in seconds. This value also specifies the delay from when the user first enters a minimum-length entry in the field until the suggestion box appears. 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".

Note: The only way to get the default behavior is to omit the attribute. Otherwise, the delay must be a nonzero integer value.

autosuggestMinLength

Optional, HTML

1

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".

bind

Optional;

HTML,

Flash

A bind expression that dynamically sets an attribute of the control. For details, see Usage.

bindAttribute

Optional;

HTML

value

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".

bindOnLoad

Optional;

HTML

no

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".

checked

Optional;

all

no

Selects a radio button or check box control:

• yes
• no

For HTML format, you can indicate that the item is selected by specifying the value as checked or specifying the attribute with no value.

dayNames

Optional;

all

S, M, T, W, T, F, S

Applies to datefield type only. A comma-delimited list that sets the names of the weekdays displayed in the calendar. Sunday is the first day; the rest of the weekday names follow in the normal order.

delimiter

Optional, HTML

comma (,)

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.

disabled

Optional;

all

not disabled

Disables user input, making the control read-only. The attribute behavior depends on the format of the form as follows:

• HTML format forms: ColdFusion passes this attribute directly to the HTML. To disable input, specify disabled without a value (HTML format) or with the value disabled (XHTML compliant). To enable input, omit this attribute.
• Flash format forms: To disable input, specify disabled without an attribute, or disabled="yes" (or any ColdFusion positive Boolean value, such as true). To enable input, omit the attribute or specify disabled="no" (or any ColdFusion negative Boolean value, such as false).

enabled

Optional; Flash

yes

Boolean value that specifies whether the control is enabled. A disabled control appears in light gray. The inverse of the disabled attribute.

firstDayOfWeek

Optional;

all

0

Applies to datefield type only. Integer in the range 0-6 that specifies the first day of the week in the calendar: 0 indicates Sunday; 6 indicates Saturday.

height

Optional; see Description

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.

id

Optional;

HTML

name attribute value

The HTML ID of the form.

label

Optional; Flash, XML

Label to put next to the control on a Flash form. Not used for button, hidden, image, reset, or submit types.

mask

Optional;

Flash, HTML

For tags with type="text". A mask pattern that controls the character pattern that users can enter, or that the form sends to ColdFusion. Mask characters and the corresponding valid input characters are:

• A = [A-Za-z]
• X = [A-Za-z0-9]
• 9 = [0-9]
• ? = Any character
• All other characters = insert the literal character

For tags with type="datefield", a pattern that controls the format of dates that the user selects in the calendar. 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.

For more information, see Masking input data in Usage.

maxLength

Optional;

all

Maximum length of text entered, if type = "Text" or "password". For complete length validation, specify maxLength validation in a validate attribute; otherwise, this attribute prevents users from typing beyond the specified length, but does not prevent them from pasting in a longer value.

maxResultsDisplayed

Optional;

HTML

10

The maximum number suggestions to display in the autosuggest list.

Valid only for cfinput type="text".

message

Optional;

all

Message text to display if validation fails.

monthNames

Optional;

all

January, February, March, April, May, June, July, August, September, October, November, December

Applies to datefield type only. A comma-delimited list of the month names that display at the top of the calendar.

onBindError

Optional;

HTML

See Description

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.

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.

onChange

Optional;

all

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.

onClick

Optional;

all

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.

onError

Optional;

HTML, XML

Name of a custom JavaScript function to execute if validation fails.

onKeyDown

Optional;

all

JavaScript (HTML/XML) or ActionScript (Flash) ActionScript to run when the user presses a keyboard key in the control.

onKeyUp

Optional;

all

JavaScript (HTML/XML) or ActionScript (Flash) to run when the user releases a keyboard key in the control.

onMouseDown

Optional;

all

JavaScript (HTML/XML) or ActionScript (Flash) to run when the user releases a mouse button in the control.

onMouseUp

Optional;

all

JavaScript (HTML/XML) or ActionScript (Flash) to run when the user presses a mouse button in the control.

onValidate

Optional;

HTML, XML

Name of a 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.

pattern

Required if validate= "regex";

HTML, XML

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. For examples and syntax, see "Building Dynamic Forms with cfform Tags" in the ColdFusion Developer's Guide.

range

Optional;

all

Minimum and maximum allowed numeric values. ColdFusion uses this attribute only if you specify range in the validate attribute.

If you specify a single number or a single number 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.

required

Optional;

all

no

• yes: the field must contain data.
• no: allows an empty field.

showAutosuggestLoadingIcon

Optional; HTML

true

A Boolean value that specifies whether to display an animated icon when loading an autosuggest value for a text input.

size

Optional;

all

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.

sourceForTooltip

Optional; HTML

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.

src

Optional;

Flash, HTML

Applies to Flash button, reset, submit, and image types, and the HTML image type. URL of an image to use on the button.

style

Optional;

all

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 ColdFusion Developer's Guide.

In XML format, ColdFusion passes the style attribute to the XML.

tooltip

Optional; Flash, HTML

Text to display when the mouse pointer hovers over the control.

Ignored if you specify a sourceForTooltip attribute.

type

Optional;

all

text

The input control type to create:

• button: push button.
• checkbox: check box.
• datefield: HTML and Flash only; date entry field with an expanding calendar from which users select the date or dates. In HTML format only, users can also enter the date by typing in the field.
• 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.

typeahead

Optional;

HTML

no

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".

validate

Optional;

all

The type or types of validation to do. Available validation types and algorithms depend on the format. For details, see Usage.

validateAt

Optional;

all

onSubmit

How to do the validation; one or more of the following values:

• onSubmit
• onServer
• onBlur

The onBlur and onSubmit values are identical in Flash forms. For multiple values, use a comma-delimited list.

For details, see Usage.

value

depends on type setting;

all

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.

visible

Optional; Flash

yes

Boolean value that specifies whether to show the control. Space that would be occupied by an invisible control is blank.

width

Optional; see Description

Applies to most Flash types, and 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.

date

If validateAt="onServer", allows any date format that returns true in the IsDate function; otherwise, same as USdate.

USdate

A US date of the format mm/dd/yy mm-dd-yy or mm.dd.yy, with 1-2 digit days and months, 1-4 digit years.

eurodate

A date of the format dd/mm/yy, with 1-2 digit days and months, 1-4 digit years. The format can use /, -, or . characters as delimiters.

time

Time format hh:mm:ss

float or numeric

A number; allows integers.

integer

An integer.

range

A numeric range.

boolean

A value that can be converted to a Boolean value: Yes, No, True, False, or a number.

telephone

Standard U.S. telephone formats. Allows an initial 1 long-distance designator and up to 5-digit extensions, optionally starting with x.

zipcode

U.S. 5- or 9-digit ZIP code format #####-####. The separator can be a hyphen (-) or a space.

creditcard

Strips blanks and dashes; verifies number using mod10 algorithm. Number must have 13-16 digits.

ssn or social_security_number

US. Social Security number format, ###-##-####. The separator can be a hyphen (-) or a space.

email

A valid e-mail address of the form name@server.domain. ColdFusion validates the format only; it does not check that entry is a valid active e-mail address.

URL

A valid URL pattern; supports http, https, ftp file, mailto, and news URLs.

guid

A unique identifier that follows the Microsoft/DCE format, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, where x is a hexadecimal number.

uuid

A universally unique identifier (UUID) that follows the ColdFusion format, xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx, where x is a hexadecimal number.

maxlength

Limits the input to a maximum number of characters.

noblanks

Does not allow fields that consist only of blanks.

regex or regular_expression

Matches input against the pattern attribute. Valid in HTML and XML format only; ignored in Flash format.

SubmitOnce

Used only with submit and image types; prevents the user from submitting the same form multiple times before until the next page loads (for example, submitting an order a second time before getting the first order confirmation). Valid in HTML and XML format only; ignored in Flash format.

D

Single- or double-digit day of month, such as 1 or 28

DD

Double-digit day of month, such as 01 or 28

M

Single- or double-digit month, such as 1 or 12

MM

Double-digit month, such as 01 or 12

MMM

Abbreviated month name, such as Jan or Dec

MMMM

Full month name, such as January or December

YY

Two-character year, such as 05

YYYY

Four-character year, such as 2005

E

Single-digit day of week, such as 1 or 7

EEE

Abbreviated day of week name, such as Mon or Sun

EEEE

Full month day of week name, such as Monday or Sunday