yearSelectTag()
Description
Builds and returns a string containing a select form control for a range of years based on the supplied name.
Function Syntax
yearSelectTag(name [, selected, startYear, endYear, includeBlank, label, labelPlacement, prepend, append, prependToLabel, appendToLabel ])
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name |
string |
Yes | |
Name to populate in tag's name attribute. |
selected |
string |
No | |
The year that should be selected initially. |
startYear |
numeric |
No | 2005 |
First year in select list. |
endYear |
numeric |
No | 2015 |
Last year in select list. |
includeBlank |
any |
No | false |
Whether to include a blank option in the select form control. Pass true to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -"). |
label |
string |
No | |
The label text to use in the form control. |
labelPlacement |
string |
No | around |
Whether to place the label before, after, or wrapped around the form control. |
prepend |
string |
No | |
String to prepend to the form control. Useful to wrap the form control with HTML tags. |
append |
string |
No | |
String to append to the form control. Useful to wrap the form control with HTML tags. |
prependToLabel |
string |
No | |
String to prepend to the form control's label. Useful to wrap the form control with HTML tags. |
appendToLabel |
string |
No | |
String to append to the form control's label. Useful to wrap the form control with HTML tags. |
Examples
<!--- View code --->
<cfoutput>
#yearSelectTag(name="yearOfBirthday", selected=params.yearOfBirthday)#
</cfoutput>
<!--- Only allow selection of year to be for the past 50 years, minimum being 18 years ago --->
<cfset fiftyYearsAgo = Now() - 50>
<cfset eighteenYearsAgo = Now() - 18>
<cfoutput>
#yearSelectTag(name="yearOfBirthday", selected=params.yearOfBirthday, startYear=fiftyYearsAgo, endYear=eighteenYearsAgo)#
</cfoutput>
