hourSelectTag()
Description
Builds and returns a string containing one select form control for the hours of the day based on the supplied name.
Function Syntax
hourSelectTag(name [, selected, includeBlank, label, labelPlacement, prepend, append, prependToLabel, appendToLabel, twelveHour ])
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name |
string |
Yes | |
Name to populate in tag's name attribute. |
selected |
string |
No | |
The hour that should be selected initially. |
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. |
twelveHour |
boolean |
No | false |
whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs |
Examples
<!--- This "Tag" version of the function accepts a `name` and `selected` instead of binding to a model object --->
<cfoutput>
#hourSelectTag(name="hourOfMeeting", selected=params.hourOfMeeting)#
</cfoutput>
<!--- Show 12 hours instead of 24 --->
<cfoutput>
#hourSelectTag(name="hourOfMeeting", selected=params.hourOfMeeting, twelveHour=true)#
</cfoutput>
